Render pass attachment descriptor structure. More...

#include <RenderPassFlags.h>

Public Member Functions
	AttachmentFormatDescriptor ()=default
	AttachmentFormatDescriptor (const Format format, const AttachmentLoadOp loadOp=AttachmentLoadOp::Load, const AttachmentStoreOp storeOp=AttachmentStoreOp::Store)
	Constructor to initialize the format and optionally the load and store operations.

Public Attributes
Format	format = Format::Undefined
	Specifies the render target attachment format. By default Format::Undefined.
AttachmentLoadOp	loadOp = AttachmentLoadOp::Undefined
	Specifies the load operation of the previous attachment content. By default AttachmentLoadOp::Undefined.
AttachmentStoreOp	storeOp = AttachmentStoreOp::Undefined
	Specifies the store operation of the outcome for the respective attachment content. By default AttachmentStoreOp::Undefined.

Detailed Description

Render pass attachment descriptor structure.

Remarks: Two attachment format descriptors are considered compatible when their formats and multi-sampling attributes are matching.

Constructor & Destructor Documentation

LLGL::AttachmentFormatDescriptor::AttachmentFormatDescriptor ( )

default

LLGL::AttachmentFormatDescriptor::AttachmentFormatDescriptor	(	const Format	format,
		const AttachmentLoadOp	loadOp = AttachmentLoadOp::Load,
		const AttachmentStoreOp	storeOp = AttachmentStoreOp::Store )

inline

Constructor to initialize the format and optionally the load and store operations.

Format LLGL::AttachmentFormatDescriptor::format = Format::Undefined

Specifies the render target attachment format. By default Format::Undefined.

Remarks: If the render pass is used for a swap-chain, the appropriate color format can be determined by the SwapChain::GetColorFormat function, and the appropriate depth-stencil format can be determined by the SwapChain::GetDepthStencilFormat function. If the render pass is used for render targets, the format depends on the render target attachments. If this is undefined, the corresponding attachment is not used.

AttachmentLoadOp LLGL::AttachmentFormatDescriptor::loadOp = AttachmentLoadOp::Undefined

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.

Specifies the store operation of the outcome for the respective attachment content. By default AttachmentStoreOp::Undefined.

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