Loading...
Searching...
No Matches
Public Attributes | List of all members
HgiAttachmentDesc Struct Reference

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

#include <attachmentDesc.h>

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 48 of file attachmentDesc.h.

Constructor & Destructor Documentation

◆ HgiAttachmentDesc()

HgiAttachmentDesc ( )
inline

Definition at line 50 of file attachmentDesc.h.

Member Data Documentation

◆ alphaBlendOp

HgiBlendOp alphaBlendOp

Definition at line 80 of file attachmentDesc.h.

◆ blendConstantColor

GfVec4f blendConstantColor

Definition at line 81 of file attachmentDesc.h.

◆ blendEnabled

bool blendEnabled

Definition at line 74 of file attachmentDesc.h.

◆ clearValue

GfVec4f clearValue

Definition at line 72 of file attachmentDesc.h.

◆ colorBlendOp

HgiBlendOp colorBlendOp

Definition at line 77 of file attachmentDesc.h.

◆ colorMask

HgiColorMask colorMask

Definition at line 73 of file attachmentDesc.h.

◆ dstAlphaBlendFactor

HgiBlendFactor dstAlphaBlendFactor

Definition at line 79 of file attachmentDesc.h.

◆ dstColorBlendFactor

HgiBlendFactor dstColorBlendFactor

Definition at line 76 of file attachmentDesc.h.

◆ format

HgiFormat format

Definition at line 68 of file attachmentDesc.h.

◆ loadOp

HgiAttachmentLoadOp loadOp

Definition at line 70 of file attachmentDesc.h.

◆ srcAlphaBlendFactor

HgiBlendFactor srcAlphaBlendFactor

Definition at line 78 of file attachmentDesc.h.

◆ srcColorBlendFactor

HgiBlendFactor srcColorBlendFactor

Definition at line 75 of file attachmentDesc.h.

◆ storeOp

HgiAttachmentStoreOp storeOp

Definition at line 71 of file attachmentDesc.h.

◆ usage

HgiTextureUsage usage

Definition at line 69 of file attachmentDesc.h.

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