NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::Index_cuda_canvas_creation_properties Class Reference

Implements the properties required by NVIDIA IndeX for creating a CUDA canvas. More...

#include <iindex.h>

Inherits mi::base::Interface_implement< nv::index::IIndex_cuda_canvas_creation_properties >.

Public Member Functions

 Index_cuda_canvas_creation_properties (mi::Sint32 cuda_device_id, const mi::math::Vector_struct< mi::Uint32, 2 > &resolution)
 Create an instance that delivers all properties required for creating a CUDA canvas. More...
 
virtual mi::Sint32 get_cuda_device_id () const
 A CUDA device hosts the canvas contents in the CUDA buffer. More...
 
virtual const mi::math::Vector_struct< mi::Uint32, 2 > & get_resolution () const
 A canvas has a given resolution. More...
 

Detailed Description

Implements the properties required by NVIDIA IndeX for creating a CUDA canvas.

This implementation is to be moved to the application layer.

Constructor & Destructor Documentation

 Index_cuda_canvas_creation_properties()

nv::index::Index_cuda_canvas_creation_properties::Index_cuda_canvas_creation_properties ( mi::Sint32  cuda_device_id,
const mi::math::Vector_struct< mi::Uint32, 2 > &  resolution 
)
inline

Create an instance that delivers all properties required for creating a CUDA canvas.

Parameters
[in]cuda_device_idDefines the cuda device on which a memory for a cuda canvas shall be allocated. If set to '-1' or an invalid/undefined cuda device, then NVIDIA IndeX selects a device.
[in]resolutionThe resolution of the requested built-in canvas.

Member Function Documentation

 get_cuda_device_id()

virtual mi::Sint32 nv::index::Index_cuda_canvas_creation_properties::get_cuda_device_id ( ) const
inlinevirtual

A CUDA device hosts the canvas contents in the CUDA buffer.

Returns
Returns the CUDA device id that stores the canvas contents.

 get_resolution()

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

A canvas has a given resolution.

Returns
Returns the resolutions of the canvas.

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