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

Describes the properties needed to create a GPU sampler. More...

#include <sampler.h>

Public Attributes

std::string debugName
 
HgiSamplerFilter magFilter
 
HgiSamplerFilter minFilter
 
HgiMipFilter mipFilter
 
HgiSamplerAddressMode addressModeU
 
HgiSamplerAddressMode addressModeV
 
HgiSamplerAddressMode addressModeW
 
HgiBorderColor borderColor
 
bool enableCompare
 
HgiCompareFunction compareFunction
 

Detailed Description

Describes the properties needed to create a GPU sampler.

  • debugName: This label can be applied as debug label for GPU debugging.
  • magFilter: The (magnification) filter used to combine pixels when the sample area is smaller than a pixel.
  • minFilter: The (minification) filter used to combine pixels when the sample area is larger than a pixel.
  • mipFilter: The filter used for combining pixels between two mipmap levels.
  • addressMode***: Wrapping modes.
  • borderColor: The border color for clamped texture values.
  • enableCompare: Enables sampler comparison against a reference value during lookups.
  • compareFunction: The comparison function to apply if sampler compare is enabled.

Definition at line 64 of file sampler.h.

Constructor & Destructor Documentation

◆ HgiSamplerDesc()

HgiSamplerDesc ( )
inline

Definition at line 66 of file sampler.h.

Member Data Documentation

◆ addressModeU

HgiSamplerAddressMode addressModeU

Definition at line 82 of file sampler.h.

◆ addressModeV

HgiSamplerAddressMode addressModeV

Definition at line 83 of file sampler.h.

◆ addressModeW

HgiSamplerAddressMode addressModeW

Definition at line 84 of file sampler.h.

◆ borderColor

HgiBorderColor borderColor

Definition at line 85 of file sampler.h.

◆ compareFunction

HgiCompareFunction compareFunction

Definition at line 87 of file sampler.h.

◆ debugName

std::string debugName

Definition at line 78 of file sampler.h.

◆ enableCompare

bool enableCompare

Definition at line 86 of file sampler.h.

◆ magFilter

HgiSamplerFilter magFilter

Definition at line 79 of file sampler.h.

◆ minFilter

HgiSamplerFilter minFilter

Definition at line 80 of file sampler.h.

◆ mipFilter

HgiMipFilter mipFilter

Definition at line 81 of file sampler.h.

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