HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
HgiAttachmentDesc Struct Reference

#include <attachmentDesc.h>

Public Member Functions

 HgiAttachmentDesc ()
 

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.

Constructor & Destructor Documentation

HgiAttachmentDesc::HgiAttachmentDesc ( )
inline

Definition at line 67 of file attachmentDesc.h.

Member Data Documentation

HgiBlendOp HgiAttachmentDesc::alphaBlendOp

Definition at line 97 of file attachmentDesc.h.

GfVec4f HgiAttachmentDesc::blendConstantColor

Definition at line 98 of file attachmentDesc.h.

bool HgiAttachmentDesc::blendEnabled

Definition at line 91 of file attachmentDesc.h.

GfVec4f HgiAttachmentDesc::clearValue

Definition at line 89 of file attachmentDesc.h.

HgiBlendOp HgiAttachmentDesc::colorBlendOp

Definition at line 94 of file attachmentDesc.h.

HgiColorMask HgiAttachmentDesc::colorMask

Definition at line 90 of file attachmentDesc.h.

HgiBlendFactor HgiAttachmentDesc::dstAlphaBlendFactor

Definition at line 96 of file attachmentDesc.h.

HgiBlendFactor HgiAttachmentDesc::dstColorBlendFactor

Definition at line 93 of file attachmentDesc.h.

HgiFormat HgiAttachmentDesc::format

Definition at line 85 of file attachmentDesc.h.

HgiAttachmentLoadOp HgiAttachmentDesc::loadOp

Definition at line 87 of file attachmentDesc.h.

HgiBlendFactor HgiAttachmentDesc::srcAlphaBlendFactor

Definition at line 95 of file attachmentDesc.h.

HgiBlendFactor HgiAttachmentDesc::srcColorBlendFactor

Definition at line 92 of file attachmentDesc.h.

HgiAttachmentStoreOp HgiAttachmentDesc::storeOp

Definition at line 88 of file attachmentDesc.h.

HgiTextureUsage HgiAttachmentDesc::usage

Definition at line 86 of file attachmentDesc.h.

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