Class RenderTarget

• Defined in File RenderTarget.h

Inheritance Relationships

Derived Type

• public TRAP::Graphics::API::VulkanRenderTarget (Class VulkanRenderTarget)

Class Documentation

class RenderTarget

Subclassed by TRAP::Graphics::API::VulkanRenderTarget

Public Functions

virtual ~RenderTarget()

Destructor.

consteval RenderTarget(const RenderTarget&) = delete

Copy constructor.

consteval RenderTarget &operator=(const RenderTarget&) = delete

Copy assignment operator.

RenderTarget(RenderTarget&&) noexcept = default

Move constructor.

RenderTarget &operator=(RenderTarget&&) noexcept = default

Move assignment operator.

constexpr u32 GetWidth() const noexcept

Retrieve the width of the render target.

Returns:

Render target width.

constexpr u32 GetHeight() const noexcept

Retrieve the height of the render target.

Returns:

Render target height.

constexpr u32 GetDepth() const noexcept

Retrieve the depth of the render target.

Returns:

Render target depth.

constexpr u32 GetArraySize() const noexcept

Retrieve the array size of the render target.

Returns:

Render target array size.

constexpr u32 GetMipLevels() const noexcept

Retrieve the mip levels of the render target.

Returns:

Render target mip levels.

constexpr RendererAPI::SampleCount GetSampleCount() const noexcept

Retrieve the sample count of the render target.

Returns:

Render target sample count.

constexpr u32 GetSampleQuality() const noexcept

Retrieve the sample quality of the render target.

Returns:

Render target sample quality.

constexpr TRAP::Graphics::API::ImageFormat GetImageFormat() const noexcept

Retrieve the image format of the render target.

Returns:

Render target image format.

constexpr TRAP::Graphics::RendererAPI::ClearValue GetClearValue() const noexcept

Retrieve the clear color of the render target.

Returns:

Render target clear color.

constexpr RendererAPI::DescriptorType GetDescriptorType() const noexcept

Retrieve the descriptor type of the render target.

Returns:

Render target descriptor type.

Ref<TRAP::Graphics::Texture> GetTexture() const noexcept

Retrieve the texture base of the render target.

Returns:

Render target texture base.

Public Static Functions

static TRAP::Ref<RenderTarget> Create(const RendererAPI::RenderTargetDesc &desc)

Create a new render target from the given description.

Parameters:

desc – Render target description.

Returns:

Created render target.

Protected Functions

explicit RenderTarget(const RendererAPI::RenderTargetDesc &desc)

Constructor.

Protected Attributes

TRAP::Ref<TRAP::Graphics::Texture> m_texture = nullptr

RendererAPI::ClearValue m_clearValue = RendererAPI::Color{1.0, 1.0, 1.0, 1.0}

u32 m_arraySize = 0

u32 m_depth = 0

u32 m_width = 0

u32 m_height = 0

RendererAPI::DescriptorType m_descriptors = RendererAPI::DescriptorType::Undefined

u32 m_mipLevels = 0

u32 m_sampleQuality = 0

TRAP::Graphics::API::ImageFormat m_format = TRAP::Graphics::API::ImageFormat::Undefined

RendererAPI::SampleCount m_sampleCount = RendererAPI::SampleCount::One