Overte C++ Documentation
gpu::State::DepthTest Class Reference

Represents setting for depth testing and writing. More...

#include <State.h>

Public Member Functions

 DepthTest (bool enabled=false, bool writeMask=true, ComparisonFunction func=ComparisonFunction::LESS)
 
bool isEnabled () const
 
ComparisonFunction getFunction () const
 
uint8 getWriteMask () const
 

Public Attributes

uint8 writeMask { true }
 Enable writing to the depth buffer.
 
uint8 enabled { false }
 Enable depth test.
 

Detailed Description

Represents setting for depth testing and writing.

Constructor & Destructor Documentation

◆ DepthTest()

gpu::State::DepthTest::DepthTest ( bool  enabled = false,
bool  writeMask = true,
ComparisonFunction  func = ComparisonFunction::LESS 
)
inline
Parameters
enabledtrue if depth testing is enabled.
writeMasktrue if writing to depth buffer is enabled.
funcComparison function to use for depth thest.

Member Function Documentation

◆ getFunction()

ComparisonFunction gpu::State::DepthTest::getFunction ( ) const
inline
Returns
Comparison function used for depth testing.

◆ getWriteMask()

uint8 gpu::State::DepthTest::getWriteMask ( ) const
inline
Returns
true if writing to depth buffer is enabled.

◆ isEnabled()

bool gpu::State::DepthTest::isEnabled ( ) const
inline
Returns
true if depth testing is enabled.

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