nv::index::IDepth_test Class Reference

Defines a depth test for the shapes defined in the scene description. More...

#include <idepth_test.h>

Inherits mi::base::Interface_declare< 0xa8a4d29c, ... >.

Public Types
enum	Depth_test_mode {   TEST_LESS = 0 ,   TEST_LESS_EQUAL = 1 }
	Depth test modes that are supported by NVIDIA IndeX. More...

Public Member Functions
virtual void	set_depth_test (Depth_test_mode test)=0
	Set depth test operator of this attribute. More...
virtual Depth_test_mode	get_depth_test () const =0
	Get current depth test operator of this attribute. More...

Detailed Description

Defines a depth test for the shapes defined in the scene description.

Similar to the depth tests in OpenGL, NVIDIA IndeX allows the application to define the depth ordering of shapes on a 'per-fragment' level. The depth test operation represents an attribute in the scene description and has an effect on all the shapes that are defined subsequently in the hierarchical description of the scene.

Member Enumeration Documentation

Depth_test_mode

enum nv::index::IDepth_test::Depth_test_mode

Depth test modes that are supported by NVIDIA IndeX.

Enumerator
TEST_LESS	z-test less operator (<)
TEST_LESS_EQUAL	z-test less than or equal operator (<=)

Member Function Documentation

get_depth_test()

virtual Depth_test_mode nv::index::IDepth_test::get_depth_test ( ) const

pure virtual

Get current depth test operator of this attribute.

Returns

Returns the current depth test operator.

set_depth_test()

virtual void nv::index::IDepth_test::set_depth_test ( Depth_test_mode  test )

pure virtual

Set depth test operator of this attribute.

The default depth test operation is TEST_LESS_EQUAL.

Parameters

[in]

test

The parameter defines the depth test operator.

---

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

• idepth_test.h