All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiSamplerDesc Struct Reference

#include <sampler.h>

Public Member Functions

 HgiSamplerDesc ()

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 ( )

Definition at line 66 of file sampler.h.

Member Data Documentation

HgiSamplerAddressMode HgiSamplerDesc::addressModeU

Definition at line 82 of file sampler.h.

HgiSamplerAddressMode HgiSamplerDesc::addressModeV

Definition at line 83 of file sampler.h.

HgiSamplerAddressMode HgiSamplerDesc::addressModeW

Definition at line 84 of file sampler.h.

HgiBorderColor HgiSamplerDesc::borderColor

Definition at line 85 of file sampler.h.

HgiCompareFunction HgiSamplerDesc::compareFunction

Definition at line 87 of file sampler.h.

std::string HgiSamplerDesc::debugName

Definition at line 78 of file sampler.h.

bool HgiSamplerDesc::enableCompare

Definition at line 86 of file sampler.h.

HgiSamplerFilter HgiSamplerDesc::magFilter

Definition at line 79 of file sampler.h.

HgiSamplerFilter HgiSamplerDesc::minFilter

Definition at line 80 of file sampler.h.

HgiMipFilter HgiSamplerDesc::mipFilter

Definition at line 81 of file sampler.h.

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