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

Mixin class for implementing the IIndex_canvas interface. More...

#include <iindex_canvas.h>

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

Public Member Functions

virtual mi::Uint32 get_nb_frame_buffer_layers () const
 Return number of layers. More...
 
virtual Frame_buffer_layer_type get_layer_type (mi::Uint32) const
 Return the frame buffer layer type. More...
 
virtual void render_tile (mi::Uint32, Frame_buffer_layer_type layer_type, const mi::math::Bbox_struct< mi::Uint32, 2 > &area, mi::Uint8 *buffer)
 Implemented render tile method of the canvas interface. More...
 
virtual mi::neuraylib::ICanvas * get_canvas () const
 Returns the canvas that hosts the rendered pixels. More...
 

Detailed Description

Mixin class for implementing the IIndex_canvas interface.

This mixin class provides a default implementation of some of the pure virtual methods of the IIndex_canvas interface.

Member Function Documentation

 get_canvas()

virtual mi::neuraylib::ICanvas * nv::index::Index_canvas::get_canvas ( ) const
inlinevirtual

Returns the canvas that hosts the rendered pixels.

Returns
The main memory canvas that contains the rendered image.

IIndex_canvas::get_canvas.

 get_layer_type()

virtual Frame_buffer_layer_type nv::index::Index_canvas::get_layer_type ( mi::Uint32  ) const
inlinevirtual

Return the frame buffer layer type.

Returns
The Frame_buffer_layer_type

 get_nb_frame_buffer_layers()

virtual mi::Uint32 nv::index::Index_canvas::get_nb_frame_buffer_layers ( ) const
inlinevirtual

Return number of layers.

Returns
The number of layers.

 render_tile()

virtual void nv::index::Index_canvas::render_tile ( mi::Uint32  ,
Frame_buffer_layer_type  layer_type,
const mi::math::Bbox_struct< mi::Uint32, 2 > &  area,
mi::Uint8 *  buffer 
)
inlinevirtual

Implemented render tile method of the canvas interface.

Parameters
[in]layer_typeThe type of the layer.
[in]areaThe 2D bounding box of the tile covered in the screen space.
[in]bufferThe image buffer that contains the rendering inside the tile area.

IIndex_canvas::render_tile.


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