NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::ICompute_plane_parameters Class Referenceabstract

Interface to parameters of a compute plane. More...

#include <icompute.h>

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

Public Member Functions

virtual void set_resolution (const mi::math::Vector_struct< mi::Uint32, 2 > &res)=0
 Define surface parameterization of the plane. This specifies the resolution of the 2D result buffer. More...
 
virtual bool set_value_sizes (const mi::Uint32 *value_sizes, mi::Uint32 nb_values)=0
 Define the format of compute values. More...
 
virtual mi::math::Vector_struct< mi::Uint32, 2 > get_resolution () const =0
 Get the specified resolution. More...
 
virtual mi::Uint32 get_nb_values () const =0
 Get the number of values specified. More...
 
virtual mi::Uint32 get_value_size (mi::Uint32 i) const =0
 Get the byte size of value i. More...
 

Detailed Description

Interface to parameters of a compute plane.

Applying this attribute to a IPlane scene element makes the IPlane a valid target for a ICompute_launch_request.

Member Function Documentation

 get_nb_values()

virtual mi::Uint32 nv::index::ICompute_plane_parameters::get_nb_values ( ) const
pure virtual

Get the number of values specified.

 get_resolution()

virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::ICompute_plane_parameters::get_resolution ( ) const
pure virtual

Get the specified resolution.

 get_value_size()

virtual mi::Uint32 nv::index::ICompute_plane_parameters::get_value_size ( mi::Uint32  i) const
pure virtual

Get the byte size of value i.

 set_resolution()

virtual void nv::index::ICompute_plane_parameters::set_resolution ( const mi::math::Vector_struct< mi::Uint32, 2 > &  res)
pure virtual

Define surface parameterization of the plane. This specifies the resolution of the 2D result buffer.

 set_value_sizes()

virtual bool nv::index::ICompute_plane_parameters::set_value_sizes ( const mi::Uint32 *  value_sizes,
mi::Uint32  nb_values 
)
pure virtual

Define the format of compute values.

(Similar to IRay_sampling_value_format). This defines the value slots to which a XAC compute program can write per invocation.

Parameters
[in]value_sizesSizes of values (in bytes) for nb_values (max. 64 byte per value).
[in]nb_valuesNumber of values (max. 32),
Returns
false if number of values is too large or if any of the value sizes is invalid.

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