HgiAttachmentDesc Struct Reference

Describes the properties of a framebuffer attachment. More...

Public Attributes

HgiFormat format
 
HgiTextureUsage usage
 
HgiAttachmentLoadOp loadOp
 
HgiAttachmentStoreOp storeOp
 
GfVec4f clearValue
 
HgiColorMask colorMask
 
bool blendEnabled
 
HgiBlendFactor srcColorBlendFactor
 
HgiBlendFactor dstColorBlendFactor
 
HgiBlendOp colorBlendOp
 
HgiBlendFactor srcAlphaBlendFactor
 
HgiBlendFactor dstAlphaBlendFactor
 
HgiBlendOp alphaBlendOp
 
GfVec4f blendConstantColor
 

Detailed Description

Describes the properties of a framebuffer attachment.

  • format: The format of the attachment. Must match what is set in HgiTextureDesc.
  • usage: Describes how the texture is intended to be used. Must match what is set in HgiTextureDesc.
  • loadOp: The operation to perform on the attachment pixel data prior to rendering.
  • storeOp: The operation to perform on the attachment pixel data after rendering.
  • clearValue: The value to clear the attachment with (r,g,b,a) or (depth,stencil,x,x)
  • colorMask: Whether to permit or restrict writing to component channels.
  • blendEnabled: Determines if a blend operation should be applied to the attachment.
  • ***BlendFactor: The blend factors for source and destination.
  • ***BlendOp: The blending operation.
  • blendConstantColor: The constant color for blend operations.

Definition at line 65 of file attachmentDesc.h.


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