Development

Renderer/Resources/ResourceDesc.h

Public include <Renderer/Resources/ResourceDesc.h>. SnBuild module Resources.

SnAPI::Renderer::EIndexFormat

enum class SnAPI::Renderer::EIndexFormat : std::uint8_t

UInt16 = 0

UInt32

UInt8

SnAPI::Renderer::EMemoryClass

enum class SnAPI::Renderer::EMemoryClass : std::uint8_t

DeviceLocal = 0

Upload

Readback

SnAPI::Renderer::ETextureUsage

enum class SnAPI::Renderer::ETextureUsage : std::uint8_t

Sampled = 0

Storage

StorageSampled

RenderTarget

DepthTarget

SnAPI::Renderer::ETextureDimension

enum class SnAPI::Renderer::ETextureDimension : std::uint8_t

Texture2D = 0

Texture3D

Texture2DArray

TextureCube

SnAPI::Renderer::ESamplerFilter

enum class SnAPI::Renderer::ESamplerFilter : std::uint8_t

Nearest = 0

Linear

SnAPI::Renderer::ESamplerAddressMode

enum class SnAPI::Renderer::ESamplerAddressMode : std::uint8_t

Repeat = 0

ClampToEdge

MirroredRepeat

ClampToBorder

SnAPI::Renderer::RenderResolutionScale2D

struct SnAPI::Renderer::RenderResolutionScale2D

SnAPI::Renderer::RenderResolutionScale2D::ScaleX

double SnAPI::Renderer::RenderResolutionScale2D::ScaleX = 1.0

See also SnAPI::Renderer::RenderResolutionScale2D.

SnAPI::Renderer::RenderResolutionScale2D::ScaleY

double SnAPI::Renderer::RenderResolutionScale2D::ScaleY = 1.0

See also SnAPI::Renderer::RenderResolutionScale2D.

SnAPI::Renderer::RenderExtentSpec

using SnAPI::Renderer::RenderExtentSpec = std::variant<Extent2D, RenderResolutionScale2D>

See also SnAPI::Renderer::Extent2D, SnAPI::Renderer::RenderResolutionScale2D.

SnAPI::Renderer::ERenderTargetExtentParent

enum class SnAPI::Renderer::ERenderTargetExtentParent : std::uint8_t

InternalRender = 0

Output

PlatformPresentation

SnAPI::Renderer::TextureDesc

struct SnAPI::Renderer::TextureDesc

SnAPI::Renderer::TextureDesc::Extent

Extent2D SnAPI::Renderer::TextureDesc::Extent {}

See also SnAPI::Renderer::TextureDesc, SnAPI::Renderer::Extent2D.

SnAPI::Renderer::TextureDesc::Format

ETextureFormat SnAPI::Renderer::TextureDesc::Format = ETextureFormat::RGBA8UNorm

See also SnAPI::Renderer::TextureDesc, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::TextureDesc::Dimension

ETextureDimension SnAPI::Renderer::TextureDesc::Dimension = ETextureDimension::Texture2D

See also SnAPI::Renderer::TextureDesc, SnAPI::Renderer::ETextureDimension.

SnAPI::Renderer::TextureDesc::Depth

std::uint32_t SnAPI::Renderer::TextureDesc::Depth = 1

See also SnAPI::Renderer::TextureDesc.

SnAPI::Renderer::TextureDesc::MipCount

std::uint32_t SnAPI::Renderer::TextureDesc::MipCount = 1

See also SnAPI::Renderer::TextureDesc.

SnAPI::Renderer::TextureDesc::Usage

ETextureUsage SnAPI::Renderer::TextureDesc::Usage = ETextureUsage::Sampled

See also SnAPI::Renderer::TextureDesc, SnAPI::Renderer::ETextureUsage.

SnAPI::Renderer::TextureDesc::DebugName

std::string SnAPI::Renderer::TextureDesc::DebugName

See also SnAPI::Renderer::TextureDesc.

SnAPI::Renderer::TextureDesc::DmaBuf

std::optional<DmaBufTextureAllocation> SnAPI::Renderer::TextureDesc::DmaBuf {}

See also SnAPI::Renderer::TextureDesc, SnAPI::Renderer::DmaBufTextureAllocation.

SnAPI::Renderer::TextureWriteRegion

struct SnAPI::Renderer::TextureWriteRegion

SnAPI::Renderer::TextureWriteRegion::MipLevel

std::uint32_t SnAPI::Renderer::TextureWriteRegion::MipLevel = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::ArrayLayer

std::uint32_t SnAPI::Renderer::TextureWriteRegion::ArrayLayer = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::OffsetX

std::uint32_t SnAPI::Renderer::TextureWriteRegion::OffsetX = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::OffsetY

std::uint32_t SnAPI::Renderer::TextureWriteRegion::OffsetY = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::OffsetZ

std::uint32_t SnAPI::Renderer::TextureWriteRegion::OffsetZ = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::Extent

Extent2D SnAPI::Renderer::TextureWriteRegion::Extent

See also SnAPI::Renderer::TextureWriteRegion, SnAPI::Renderer::Extent2D.

SnAPI::Renderer::TextureWriteRegion::Depth

std::uint32_t SnAPI::Renderer::TextureWriteRegion::Depth = 1

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureWriteRegion::RowPitchBytes

std::uint32_t SnAPI::Renderer::TextureWriteRegion::RowPitchBytes = 0

See also SnAPI::Renderer::TextureWriteRegion.

SnAPI::Renderer::TextureReadbackRegion

struct SnAPI::Renderer::TextureReadbackRegion

SnAPI::Renderer::TextureReadbackRegion::MipLevel

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::MipLevel = 0

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackRegion::ArrayLayer

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::ArrayLayer = 0

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackRegion::OffsetX

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::OffsetX = 0

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackRegion::OffsetY

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::OffsetY = 0

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackRegion::OffsetZ

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::OffsetZ = 0

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackRegion::Extent

Extent2D SnAPI::Renderer::TextureReadbackRegion::Extent

See also SnAPI::Renderer::TextureReadbackRegion, SnAPI::Renderer::Extent2D.

SnAPI::Renderer::TextureReadbackRegion::Depth

std::uint32_t SnAPI::Renderer::TextureReadbackRegion::Depth = 1

See also SnAPI::Renderer::TextureReadbackRegion.

SnAPI::Renderer::TextureReadbackPayload

struct SnAPI::Renderer::TextureReadbackPayload

SnAPI::Renderer::TextureReadbackPayload::Extent

Extent2D SnAPI::Renderer::TextureReadbackPayload::Extent {}

See also SnAPI::Renderer::TextureReadbackPayload, SnAPI::Renderer::Extent2D.

SnAPI::Renderer::TextureReadbackPayload::Format

ETextureFormat SnAPI::Renderer::TextureReadbackPayload::Format = ETextureFormat::Unknown

See also SnAPI::Renderer::TextureReadbackPayload, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::TextureReadbackPayload::PresentationProfile

std::optional<SurfacePresentationProfile> SnAPI::Renderer::TextureReadbackPayload::PresentationProfile {}

See also SnAPI::Renderer::TextureReadbackPayload, SnAPI::Renderer::SurfacePresentationProfile.

SnAPI::Renderer::TextureReadbackPayload::RowPitchBytes

std::uint32_t SnAPI::Renderer::TextureReadbackPayload::RowPitchBytes = 0

See also SnAPI::Renderer::TextureReadbackPayload.

SnAPI::Renderer::TextureReadbackPayload::Depth

std::uint32_t SnAPI::Renderer::TextureReadbackPayload::Depth = 1

See also SnAPI::Renderer::TextureReadbackPayload.

SnAPI::Renderer::TextureReadbackPayload::Pixels

std::vector<std::uint8_t> SnAPI::Renderer::TextureReadbackPayload::Pixels {}

See also SnAPI::Renderer::TextureReadbackPayload.

SnAPI::Renderer::RenderTargetTextureViewDesc

struct SnAPI::Renderer::RenderTargetTextureViewDesc

SnAPI::Renderer::RenderTargetTextureViewDesc::Texture

TextureHandle SnAPI::Renderer::RenderTargetTextureViewDesc::Texture

See also SnAPI::Renderer::RenderTargetTextureViewDesc, SnAPI::Renderer::TextureHandle.

SnAPI::Renderer::RenderTargetTextureViewDesc::MipLevel

std::uint32_t SnAPI::Renderer::RenderTargetTextureViewDesc::MipLevel = 0

See also SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::RenderTargetTextureViewDesc::MipLevelCount

std::uint32_t SnAPI::Renderer::RenderTargetTextureViewDesc::MipLevelCount = 1

See also SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::RenderTargetTextureViewDesc::ArrayLayer

std::uint32_t SnAPI::Renderer::RenderTargetTextureViewDesc::ArrayLayer = 0

See also SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::RenderTargetTextureViewDesc::ArrayLayerCount

std::uint32_t SnAPI::Renderer::RenderTargetTextureViewDesc::ArrayLayerCount = 1

See also SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::BufferDesc

struct SnAPI::Renderer::BufferDesc

SnAPI::Renderer::BufferDesc::SizeBytes

std::uint64_t SnAPI::Renderer::BufferDesc::SizeBytes = 0

See also SnAPI::Renderer::BufferDesc.

SnAPI::Renderer::BufferDesc::Usage

EBufferUsage SnAPI::Renderer::BufferDesc::Usage = EBufferUsage::ConstantBuffer

See also SnAPI::Renderer::BufferDesc, SnAPI::Renderer::EBufferUsage.

SnAPI::Renderer::BufferDesc::MemoryClass

EMemoryClass SnAPI::Renderer::BufferDesc::MemoryClass = EMemoryClass::DeviceLocal

See also SnAPI::Renderer::BufferDesc, SnAPI::Renderer::EMemoryClass.

SnAPI::Renderer::BufferDesc::DebugName

std::string SnAPI::Renderer::BufferDesc::DebugName

See also SnAPI::Renderer::BufferDesc.

SnAPI::Renderer::BufferDesc::AdditionalUsages

BufferUsageFlags SnAPI::Renderer::BufferDesc::AdditionalUsages {}

See also SnAPI::Renderer::BufferDesc, SnAPI::Renderer::BufferUsageFlags.

SnAPI::Renderer::BufferDesc::SupportsUsage

bool SnAPI::Renderer::BufferDesc::SupportsUsage(EBufferUsage usage) const noexcept

See also SnAPI::Renderer::BufferDesc, SnAPI::Renderer::EBufferUsage.

SnAPI::Renderer::SamplerDesc

struct SnAPI::Renderer::SamplerDesc

SnAPI::Renderer::SamplerDesc::MinFilter

ESamplerFilter SnAPI::Renderer::SamplerDesc::MinFilter = ESamplerFilter::Linear

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerFilter.

SnAPI::Renderer::SamplerDesc::MagFilter

ESamplerFilter SnAPI::Renderer::SamplerDesc::MagFilter = ESamplerFilter::Linear

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerFilter.

SnAPI::Renderer::SamplerDesc::MipFilter

ESamplerFilter SnAPI::Renderer::SamplerDesc::MipFilter = ESamplerFilter::Linear

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerFilter.

SnAPI::Renderer::SamplerDesc::MipLodBias

float SnAPI::Renderer::SamplerDesc::MipLodBias = 0.0f

See also SnAPI::Renderer::SamplerDesc.

SnAPI::Renderer::SamplerDesc::MaxAnisotropy

float SnAPI::Renderer::SamplerDesc::MaxAnisotropy = 1.0f

See also SnAPI::Renderer::SamplerDesc.

SnAPI::Renderer::SamplerDesc::AddressModeU

ESamplerAddressMode SnAPI::Renderer::SamplerDesc::AddressModeU = ESamplerAddressMode::Repeat

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerAddressMode.

SnAPI::Renderer::SamplerDesc::AddressModeV

ESamplerAddressMode SnAPI::Renderer::SamplerDesc::AddressModeV = ESamplerAddressMode::Repeat

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerAddressMode.

SnAPI::Renderer::SamplerDesc::AddressModeW

ESamplerAddressMode SnAPI::Renderer::SamplerDesc::AddressModeW = ESamplerAddressMode::Repeat

See also SnAPI::Renderer::SamplerDesc, SnAPI::Renderer::ESamplerAddressMode.

SnAPI::Renderer::SamplerDesc::DebugName

std::string SnAPI::Renderer::SamplerDesc::DebugName

See also SnAPI::Renderer::SamplerDesc.

SnAPI::Renderer::RenderTargetDesc

struct SnAPI::Renderer::RenderTargetDesc

SnAPI::Renderer::RenderTargetDesc::Extent

Extent2D SnAPI::Renderer::RenderTargetDesc::Extent

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::Extent2D.

SnAPI::Renderer::RenderTargetDesc::ExtentSpec

std::optional<RenderExtentSpec> SnAPI::Renderer::RenderTargetDesc::ExtentSpec = std::nullopt

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::RenderExtentSpec.

SnAPI::Renderer::RenderTargetDesc::ExtentParent

ERenderTargetExtentParent SnAPI::Renderer::RenderTargetDesc::ExtentParent = ERenderTargetExtentParent::Output

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::ERenderTargetExtentParent.

SnAPI::Renderer::RenderTargetDesc::ColorFormat

ETextureFormat SnAPI::Renderer::RenderTargetDesc::ColorFormat {ETextureFormat::RGBA16Float}

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::RenderTargetDesc::ColorFormats

std::vector<ETextureFormat> SnAPI::Renderer::RenderTargetDesc::ColorFormats {}

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::RenderTargetDesc::ColorTextureView

std::optional<RenderTargetTextureViewDesc> SnAPI::Renderer::RenderTargetDesc::ColorTextureView {}

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::RenderTargetDesc::DepthTextureView

std::optional<RenderTargetTextureViewDesc> SnAPI::Renderer::RenderTargetDesc::DepthTextureView {}

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::RenderTargetTextureViewDesc.

SnAPI::Renderer::RenderTargetDesc::MipCount

std::uint32_t SnAPI::Renderer::RenderTargetDesc::MipCount {1}

See also SnAPI::Renderer::RenderTargetDesc.

SnAPI::Renderer::RenderTargetDesc::CreateDepth

bool SnAPI::Renderer::RenderTargetDesc::CreateDepth {true}

See also SnAPI::Renderer::RenderTargetDesc.

SnAPI::Renderer::RenderTargetDesc::AllowStorageTextureBinding

bool SnAPI::Renderer::RenderTargetDesc::AllowStorageTextureBinding {false}

See also SnAPI::Renderer::RenderTargetDesc.

SnAPI::Renderer::RenderTargetDesc::DebugName

std::string SnAPI::Renderer::RenderTargetDesc::DebugName {}

See also SnAPI::Renderer::RenderTargetDesc.

SnAPI::Renderer::RenderTargetDesc::NormalizedColorFormats

std::vector< ETextureFormat > SnAPI::Renderer::RenderTargetDesc::NormalizedColorFormats() const

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::RenderTargetDesc::PrimaryColorFormat

ETextureFormat SnAPI::Renderer::RenderTargetDesc::PrimaryColorFormat() const noexcept

See also SnAPI::Renderer::RenderTargetDesc, SnAPI::Renderer::ETextureFormat.

SnAPI::Renderer::RenderTargetDesc::ColorAttachmentCount

std::size_t SnAPI::Renderer::RenderTargetDesc::ColorAttachmentCount() const noexcept

See also SnAPI::Renderer::RenderTargetDesc.