om::graphics::materials::ShaderBindingFlags Class Reference

A class that encapsulates the different flags that a shader binding can have. More...

#include <omGraphicsShaderBindingFlags.h>

Public Types
enum	Flag { ENABLED = (1 << 0), DYNAMIC_INPUT = (1 << 1), DEFAULT = ENABLED | DYNAMIC_INPUT, UNDEFINED = 0 }
	An enum that specifies the different shader binding flags. More...

Public Member Functions
	ShaderBindingFlags ()
	Create a new shader binding flags object with no flags set. More...
	ShaderBindingFlags (Flag flag)
	Create a new shader binding flags object with the specified flag value initially set. More...
	ShaderBindingFlags (UInt32 newFlags)
	Create a new shader binding flags object with the specified initial combined flags value. More...
const devices::GraphicsContextCapabilities &	getCapabilities () const
	Return the required capabilities that a context must support to use this shader binding. More...
void	setCapabilities (const devices::GraphicsContextCapabilities &newCapabilities)
	Set the required capabilities that a context must support to use this shader binding. More...
	operator UInt32 () const
	Convert this shader binding flags object to an integer value. More...
Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...
void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that encapsulates the different flags that a shader binding can have.

These flags provide boolean information about a shader binding. Flags are indicated by setting a single bit of a 32-bit unsigned integer to 1.

Enum values for the different flags are defined as members of the class. Typically, the user would bitwise-OR the flag enum values together to produce a final set of set flags.

Member Enumeration Documentation

enum om::graphics::materials::ShaderBindingFlags::Flag

An enum that specifies the different shader binding flags.

Enumerator
ENABLED	A flag indicating whether or not the shader binding is enabled.
DYNAMIC_INPUT	A flag indicating whether or not the renderer can dynamically supply the binding value.
DEFAULT	The default flags to use for a shader binding.
UNDEFINED	The flag value when all flags are not set.

Constructor & Destructor Documentation

om::graphics::materials::ShaderBindingFlags::ShaderBindingFlags ( )

inline

Create a new shader binding flags object with no flags set.

om::graphics::materials::ShaderBindingFlags::ShaderBindingFlags ( Flag  flag )

inline

Create a new shader binding flags object with the specified flag value initially set.

om::graphics::materials::ShaderBindingFlags::ShaderBindingFlags ( UInt32  newFlags )

inline

Create a new shader binding flags object with the specified initial combined flags value.

Member Function Documentation

const devices::GraphicsContextCapabilities& om::graphics::materials::ShaderBindingFlags::getCapabilities ( ) const

inline

Return the required capabilities that a context must support to use this shader binding.

void om::graphics::materials::ShaderBindingFlags::setCapabilities ( const devices::GraphicsContextCapabilities &  newCapabilities )

inline

Set the required capabilities that a context must support to use this shader binding.

om::graphics::materials::ShaderBindingFlags::operator UInt32 ( ) const

inline

Convert this shader binding flags object to an integer value.

This operator is provided so that the ShaderBindingFlags object can be used as an integer value for bitwise logical operations.

Bool om::graphics::materials::ShaderBindingFlags::isSet ( Flag  flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::graphics::materials::ShaderBindingFlags::set ( Flag  flag, Bool  newIsSet  )

inline

Set whether or not the specified flag value is set for this flags object.

---

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

• omGraphicsShaderBindingFlags.h