tp::DepthStencilAttachment struct

Represents an tp::ImageView as a render pass depth & stencil attachment, allowing it to be bound inside of a render pass. Also specifies any operations that are to be done on it at the beginning or end of the render pass.

Constructors, destructors, conversion operators

DepthStencilAttachment(): Describes an empty attachment.
DepthStencilAttachment(ImageView image, bool depthReadOnly, AttachmentLoadOp depthLoadOp, AttachmentStoreOp depthStoreOp, bool stencilReadOnly, AttachmentLoadOp stencilLoadOp, AttachmentStoreOp stencilStoreOp, ClearValue clearValue = {}, ImageView resolveImage = {}, ResolveMode resolveMode = ResolveMode::Average)
DepthStencilAttachment(ImageView image, bool readOnly, AttachmentLoadOp loadOp, AttachmentStoreOp storeOp, ClearValue clearValue = {}, ImageView resolveImage = {}, ResolveMode resolveMode = ResolveMode::Average)

Function documentation

tp::DepthStencilAttachment::DepthStencilAttachment(ImageView image, bool depthReadOnly, AttachmentLoadOp depthLoadOp, AttachmentStoreOp depthStoreOp, bool stencilReadOnly, AttachmentLoadOp stencilLoadOp, AttachmentStoreOp stencilStoreOp, ClearValue clearValue = {}, ImageView resolveImage = {}, ResolveMode resolveMode = ResolveMode::Average)

Parameters
image	The image view used as an attachment.
depthReadOnly	If `true`, specifies that the depth aspect will not be written to inside the render pass.
depthLoadOp	The load operation for the depth aspect done at the start of the render pass.
depthStoreOp	The store operation for the depth aspect done at the end of the render pass.
stencilReadOnly	If `true`, specifies that the stenncil aspect will not be written to inside the render pass.
stencilLoadOp	The load operation for the stencil aspect done at the start of the render pass.
stencilStoreOp	The store operation for the stencil aspect done at the end of the render pass.
clearValue	If load operation is tp::AttachmentLoadOp::Clear, specifies the clear value.
resolveImage	The image view that resolved multisample data will be written to at the end of the render pass.
resolveMode	The resolve mode that will be used if `resolveImage` is defined.

tp::DepthStencilAttachment::DepthStencilAttachment(ImageView image, bool readOnly, AttachmentLoadOp loadOp, AttachmentStoreOp storeOp, ClearValue clearValue = {}, ImageView resolveImage = {}, ResolveMode resolveMode = ResolveMode::Average)

Parameters
image	The image view used as an attachment.
readOnly	If `true`, specifies that the attachment will not be written to inside the render pass.
loadOp	The load operation done at the start of the render pass.
storeOp	The store operation done at the end of the render pass.
clearValue	If load operation is tp::AttachmentLoadOp::Clear, specifies the clear value.
resolveImage	The image view that resolved multisample data will be written to at the end of the render pass.
resolveMode	The resolve mode that will be used if `resolveImage` is defined.