Render target attachment descriptor structure. More...

#include <CeresEngine/RenderAPI/GPURenderPass.hpp>

Static Public Member Functions
template<typename Processor >
static constexpr void	reflect (Processor &&RTTI)
	Executes the given processor for every field of the struct.

Public Attributes
Format	format = Format::Undefined
	Specifies the render target attachment format.

UInt32	samples = 1
	The number of samples when multisampling is enabled.

GPUAttachmentLoadOp	loadOp = GPUAttachmentLoadOp::Load
	Specifies the load operation of the previous attachment content.

GPUAttachmentStoreOp	storeOp = GPUAttachmentStoreOp::Store
	Specifies the store operation of the outcome for the respective attachment content.

GPUImageLayout	initialLayout = GPUImageLayout::DontCare
	A hint given to the render on what the usage of the image was before the render pass begins.

GPUImageLayout	finalLayout = GPUImageLayout::ShaderAccess
	A hint given to the renderer on what the usage of the image will be on following render passes.

Detailed Description

Render target attachment descriptor structure.

Remarks: Two attachment format descriptors are considered compatible when their formats are matching.

See also: RenderPassDescriptor

Member Function Documentation

◆ reflect()

template<typename Processor >

static constexpr void CeresEngine::GPUAttachmentFormatDescriptor::reflect ( Processor && RTTI )

inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters

RTTI	The processor to be ran for every field.

Member Data Documentation

◆ finalLayout

GPUImageLayout CeresEngine::GPUAttachmentFormatDescriptor::finalLayout = GPUImageLayout::ShaderAccess

A hint given to the renderer on what the usage of the image will be on following render passes.

This can be used to prevent a image layout transition in Vulkan.

◆ format

Format CeresEngine::GPUAttachmentFormatDescriptor::format = Format::Undefined

Specifies the render target attachment format.

◆ initialLayout

GPUImageLayout CeresEngine::GPUAttachmentFormatDescriptor::initialLayout = GPUImageLayout::DontCare

A hint given to the render on what the usage of the image was before the render pass begins.

This can be used to prevent a image layout transition in Vulkan.

◆ loadOp

GPUAttachmentLoadOp CeresEngine::GPUAttachmentFormatDescriptor::loadOp = GPUAttachmentLoadOp::Load

Specifies the load operation of the previous attachment content.

By default AttachmentLoadOp::Undefined.

Remarks: If the attachment is meant to be cleared when a render pass begins, set this to AttachmentLoadOp::Clear.

See also: AttachmentLoadOp

◆ samples

UInt32 CeresEngine::GPUAttachmentFormatDescriptor::samples = 1

The number of samples when multisampling is enabled.

◆ storeOp

GPUAttachmentStoreOp CeresEngine::GPUAttachmentFormatDescriptor::storeOp = GPUAttachmentStoreOp::Store

Specifies the store operation of the outcome for the respective attachment content.

By default AttachmentStoreOp::Undefined.

See also: AttachmentStoreOp

The documentation for this struct was generated from the following file:

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPURenderPass.hpp

Static Public Member Functions

Public Attributes