nv::index::ICompute_result_buffer_2D Class Reference

Interface to compute results from a compute plane target. More...

#include <icompute.h>

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

Public Member Functions
virtual mi::math::Vector_struct< mi::Uint32, 2 >	get_resolution () const =0
	Get the resolution of this buffer. More...
virtual mi::math::Vector_struct< mi::Uint32, 2 >	get_offset () const =0
	Get offset of this buffer inside the total resolution of ICompute_plane_parameters. More...
virtual mi::Uint32	get_nb_values () const =0
	Get the number of values per buffer element,. More...
virtual mi::Uint32	get_value_size (mi::Uint32 i) const =0
	Get the byte size of value i,. More...
virtual const mi::Uint32 *	get_value_masks () const =0
	Get value mask. More...
virtual const void *	get_values (mi::Uint32 value_index) const =0
	Get values of given value index. More...

Detailed Description

Interface to compute results from a compute plane target.

Member Function Documentation

get_nb_values()

virtual mi::Uint32 nv::index::ICompute_result_buffer_2D::get_nb_values ( ) const

pure virtual

Get the number of values per buffer element,.

See also

ICompute_plane_parameters.

get_offset()

virtual mi::math::Vector_struct< mi::Uint32, 2 > nv::index::ICompute_result_buffer_2D::get_offset ( ) const

pure virtual

Get offset of this buffer inside the total resolution of ICompute_plane_parameters.

get_resolution()

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

pure virtual

Get the resolution of this buffer.

Note that this might be smaller than the resolution of ICompute_plane_parameters, depending on the bounding box given to IDistributed_data_access.

get_value_masks()

virtual const mi::Uint32 * nv::index::ICompute_result_buffer_2D::get_value_masks ( ) const

pure virtual

Get value mask.

The bits of a value mask tell if a user value was written in the XAC compute program. If the bit is 0, then the value with value index equivalent to the bit number is not valid.

Returns

Pointer to mask data with resolution dependent layout (x-major), or 0 if buffer is not valid.

get_value_size()

virtual mi::Uint32 nv::index::ICompute_result_buffer_2D::get_value_size ( mi::Uint32  i ) const

pure virtual

Get the byte size of value i,.

See also

ICompute_plane_parameters.

get_values()

virtual const void * nv::index::ICompute_result_buffer_2D::get_values ( mi::Uint32  value_index ) const

pure virtual

Get values of given value index.

A value might be invalid, if the XAC compute program did not write to it. To check this, use get_value_masks().

Parameters

[in]

value_index

Index of value (

See also

get_nb_values()).

Returns

Pointer to values with resolution dependent layout (x-major), or 0 if buffer is not valid.

---

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

• icompute.h