NVIDIA IndeX API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nv::index Namespace Reference

Namespace for NVIDIA IndeX library APIs. More...

Namespaces

 cuda
 
 xac
 
 xaclib
 Namespace for XAC library functions.
 

Classes

class  ICluster_configuration
 Interface for configuring and querying the NVIDIA IndeX cluster settings. More...
 
class  IIndex_session
 API component for creating the user session in the NVIDIA IndeX library. More...
 
class  IFrame_results
 The frame results store information gathered during the rendering process. Such information include error information and the performance values. More...
 
class  IFrame_results_list
 List of rendering results for multi-view rendering. Each list entry contains the rendering results of a single viewport. More...
 
class  IFrame_info_callbacks
 The frame info callbacks receive details related to the frame to be rendered. Such details, for instance, include the frame identifier that can be used to cancel a frame while rendering or the image tiles rendered to the canvas. The frame info allows the embedding application to derive further statistics other than the performance values from the frame rendering. More...
 
class  IIndex_canvas_creation_properties
 Interface class for creating NVIDIA IndeX built-in canvases such as a CUDA memory canvas. More...
 
class  IIndex_cuda_canvas_creation_properties
 Interface class for creating NVIDIA IndeX built-in a CUDA memory canvas. More...
 
class  Index_cuda_canvas_creation_properties
 Implements the properties required by NVIDIA IndeX for creating a CUDA canvas. This implementation is to be moved to the application layer. More...
 
class  IIndex_rendering
 Enables the rendering of a user-defined session/scene. More...
 
class  IIndex
 Interface to represent the entry point to the NVIDIA IndeX library and its functionality. Only one instance of this class may exist at the same time. It enables the configuration, start-up and shutdown of the NVIDIA IndeX library and exposes the library's API functionality through API components. More...
 
class  IAffinity_information
 Application-side control of data distribution to cluster machines and GPUs. More...
 
class  IDomain_specific_subdivision
 Domain specific subdivision and data distribution. More...
 
class  IDomain_specific_subdivision_topology
 Domain specific subdivision with topology information. More...
 
class  IAttribute
 Attributes are a part of the scene description that provide a common mechanism for parameterized information used in processing. Attributes define the rendered appearance of shapes and large-scale datasets and can be used to store meta-information in the scene description for later evaluation. Attributes can therefore affect both the rendering as well as the processing and evaluation of data. More...
 
class  IBalancing_operation
 The interface class for all balancing operations generated by NVIDIA IndeX when redistributing workload in the cluster. Each operation provides a descriptive explanation of the operation itself. More...
 
class  IReassignment_operation
 
class  IMerge_operation
 
class  ISplit_operation
 
class  IBalancing_operations
 This class serves as a collection of all workload balancing operations that occurred and the NVIDIA IndeX produced when redistributing workload for scalable rendering and data processing. More...
 
class  ICamera
 Abstract interface class representing a generic camera. More...
 
class  IPerspective_camera
 Interface class for a camera implementing the perspective camera model. More...
 
class  IOrthographic_camera
 Interface class for a camera implementing the orthographic camera model. More...
 
class  ICircle
 NVIDIA IndeX provides scene elements that enable annotating 3D scenes or implementing 3D user-interface widgets. The annotations and widgets should be composed as part of the scene description. Such additional scene elements, which include for instance the following 2D circle, integrate seamlessly into the regular 3D large-scale data rendering, i.e., the depth-correct rendering of all opaque of semi-transparent elements is ensured by NVIDIA IndeX rendering. A 2D circle represents a screen-space shape commonly used to annotating a scene or to build widgets. The circle is defined in image space, i.e., a circle is parallel to the view plane and always faces towards the viewer. More...
 
class  IClip_region
 Defines a generic clipping region that is applied to shapes. Clipping is only supported for some shapes, as described in the documentation of the individual shape scene elements. More...
 
class  ICluster_change_callback
 The interface class allows implementing user-defined callbacks issued whenever the cluster topology has changed. More...
 
class  IColormap
 An abstract representation of a colormap for storing in the distributed database. More...
 
class  IIndex_compute
 Interface to XAC compute infrastructure. Access this by using IIndex::get_api_component(). More...
 
class  ICompute_launch_request
 Interface to define a compute launch request. More...
 
class  ICompute_results
 Interface to access results of compute launch. More...
 
class  ICompute_plane_parameters
 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. More...
 
class  ICompute_result_buffer_2D
 Interface to compute results from a compute plane target. More...
 
class  ICone
 A 3D cone is defined by its base's center and a tip. Both need to be defined by a 3D coordinate in the cone's local coordinate system. A cone can be a closed object if caps are enabled, otherwise the base of the cone is open. The surface of the cone is shaded using the material and light defined in the scene description. More...
 
class  IConfig_settings
 An abstract interface for sharing global settings that configure NVIDIA IndeX rendering and computing functionality. More...
 
class  ICorner_point_grid
 Scene element representing corner-point grids. More...
 
class  ICorner_point_grid_rendering_properties
 The interface class representing rendering properties for corner-point grid data. More...
 
class  ICorner_point_grid_subset
 Defines the vertices and attributes of a subset (sub-grid) of a corner-point grid. The part of each layer that intersects with a subregion is further subdivided into patches, each having the same xy-size. Patches from different layers that have the same xy-coordinates are organized as a patch stack. More...
 
class  ICylinder
 The set of higher-level 3D shapes part of the NVIDIA IndeX library includes a 3D cylinder. ICylinder is a part of the scene description. A 3D cylinder is defined by its top and bottom position and a radius. Both positions need to be defined by a 3D coordinate in the cylinder's local coordinate system. A cylinder can be watertight, i.e., a closed object, if caps are enabled otherwise the top and the bottom of the cylinder is open. The surface of the cylinder is shaded using the material and light defined in the hierarchical scene description. More...
 
class  IDistributed_job_scheduling_mode
 
class  Distributed_job_scheduling_mode
 
class  IDistributed_job_scheduling_spatial_coverage
 
class  Distributed_job_scheduling_spatial_coverage
 Class implementing the IDistributed_job_scheduling_spatial_coverage interface class. More...
 
class  IDistributed_data_job
 The job interface class enabling distributed data analysis and processing. More...
 
class  Distributed_data_job
 This mixin class can be used to implement the mi::neuraylib::Distributed_data_job interface. More...
 
class  IDistributed_data_job_scheduler
 The interface class launching distributed data analysis and processing jobs. More...
 
class  IData_sample
 Base-interface class for all data-sample interface classes. A data sample is a single value generated by, for example, a regular volume lookup. It may represent a filtered value from multiple neighboring voxels in a regular volume. Data samples are returned, for instance, as part of a scene picking result (c.f. IScene_pick_result) when intersecting either a regular volume dataset or a geometry textured with such a volume dataset. More...
 
class  IData_sample_typed
 Intermediate-interface class for all typed data-sample interfaces. According to the actual dataset component type (e.g. Uint8, Uint16, Float32, Rgba8) the data sample value can be retrieved. More...
 
class  IData_sample_uint8
 Single-channel 8bit unsigned data sample. More...
 
class  IData_sample_uint16
 Single-channel 16bit unsigned data sample. More...
 
class  IData_sample_float32
 Single-channel 32bit floating point data sample. More...
 
class  IData_sample_rgba8
 Four-channel 8bit per channel unsigned integer data sample. More...
 
class  IDepth_offset
 Defines the depth-offset for shapes following this attribute in the scene description. The default depth offset is 0.0. This attribute only affects raster (2D) shapes. More...
 
class  IDepth_test
 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. More...
 
class  IDiagnostic_rendering_properties
 Interface representing rendering properties for diagnostic rendering. More...
 
class  IDistributed_compute_algorithm
 Interface class that enables implementing distributed computing algorithms or computing tasks that can operate on the distributed data uploaded to the cluster environment. More...
 
class  Distributed_compute_algorithm
 Mixin class for implementing the IDistributed_compute_algorithm interface. More...
 
class  IDistributed_compute_destination_buffer
 The interface class enables the asynchronous generation of 2D texture buffers and 3D volume data. Once the generation of compute-destination buffers has been triggered, for example, by means of the interface class IDistributed_compute_technique, the user-defined technique can populate the buffer contents with the values required for later texture mapping and rendering. Meanwhile, the rendering system may proceed to render datasets that don't require a particular user-defined texturing technique. More...
 
class  IDistributed_compute_destination_buffer_3d_sparse_volume
 Compute-destination buffer for 3D sparse-volume generation techniques. More...
 
class  IDistributed_compute_destination_buffer_irregular_volume
 Compute-destination buffer for irregular volume generation techniques. More...
 
class  IDistributed_compute_intersection_points
 The interface class exposes intersections points that can be used, for instance, to texture or shade the surface of geometry. More...
 
class  IDistributed_compute_destination_buffer_2d_texture
 Compute-destination buffer for 2D texture generation techniques. More...
 
class  IDistributed_compute_destination_buffer_2d_texture_LOD_configuration
 
class  IDistributed_compute_destination_buffer_2d_texture_LOD
 Compute-destination buffer for 2D LOD-texture generation techniques. More...
 
class  IDistributed_compute_technique
 Interface class for user-defined techniques for computing data (2D textures on plane and heightfield shapes and 3D volume data) on demand. More...
 
class  IDistributed_compute_technique_LOD
 Interface class for user-defined techniques for computing 2D LOD-texture data on demand. More...
 
class  Distributed_compute_technique
 Mixin class for implementing the IDistributed_compute_technique interface. More...
 
class  Distributed_compute_technique_LOD
 Mixin class for implementing the IDistributed_compute_technique_LOD interface. More...
 
class  IDistributed_data
 The base class of all distributed datasets. More...
 
class  IDistributed_data_access
 Interface class for accessing distributed data. More...
 
class  IRegular_heightfield_data_access
 Interface class for accessing the distributed heightfield data. More...
 
class  IDistributed_data_access_factory
 Interface class that exposes distributed data access interfaces for specific scene element. More...
 
class  IData_subset_processing_task
 
class  IData_subset_compute_task_processing
 
class  ISparse_volume_data_edit
 This interface class represents an entry point for user-defined editing tasks that operate on sparse-volume data distributed in the cluster. The editing operation modifies the voxel values of the volume datasets. More...
 
class  IRegular_heightfield_data_edit
 This interface class represents an entry point for user-defined editing tasks that operate on the heightfield patches to modify their elevation values. More...
 
class  IIrregular_volume_data_edit
 This interface class represents an entry point for user-defined editing tasks that operate on the irregular volume distributed in the cluster. More...
 
class  IDistributed_data_import_callback
 The interface class enables the distributed cluster-wide uploading of large-scale data, such as 3D volumetric data or 2.5D height field surface data. In general, the distributed, parallel rendering and computing algorithms are based on a spatial decomposition scheme that subdivides the 3D space into subregions. Each of these subregions contains a subset of the entire dataset. The distributed data import callback implement the upload of the subset data contained in subregions. More...
 
class  Distributed_discrete_data_import_callback
 This mixin class can be used to implement the IDistributed_data_import_callback interface. More...
 
class  Distributed_continuous_data_import_callback
 This mixin class can be used to implement the IDistributed_data_import_callback interface. More...
 
struct  Subregion_identifier
 FILL IN. More...
 
class  IDistributed_data_locality
 The interface class exposes data locality information. More...
 
class  ISparse_volume_data_locality
 The interface class exposes the locality information of a distributed sparse-volume dataset. More...
 
class  IHeight_field_data_locality
 The interface class exposes the locality information of a distributed height-field dataset. More...
 
class  IRegular_heightfield_data_locality
 The interface class exposes the locality information of a distributed regular heightfield dataset. More...
 
class  IData_distribution
 Interface class that exposes the data distribution in the cluster environment. More...
 
class  IDistributed_data_attribute_set_descriptor
 
class  IDistributed_data_subset_data_descriptor
 
class  IDistributed_data_subset
 The base class for each subset of a large-scale distributed dataset. More...
 
class  IData_subset_factory
 The interface classes derived from IDistributed_data_subset cannot be instantiated beyond the library boundary, e.g., by an application. But the data import callback (IDistributed_data_import_callback) requires an application to create instances of subset of large-scale distributed datasets. The factory interface class IData_subset_factory creates these classes for the user based on the given UUID. An implementation of this class is passed as argument to the import callback method IDistributed_data_import_callback::create(). More...
 
class  IDistributed_inference_technique
 Interface class for user-defined AI/DL inference techniques. More...
 
class  Distributed_inference_technique
 Mixin class for implementing the IDistributed_inference_technique interface. More...
 
class  IEllipse
 NVIDIA IndeX provides scene elements that enable annotating 3D scenes or implementing 3D user-interface widgets. The annotations and widgets should be composed as part of the scene description. Such additional scene elements, which include for instance the following 2D ellipse, integrate seamlessly into the regular 3D large-scale data rendering, i.e., the depth-correct rendering of all opaque of semi-transparent elements is ensured by NVIDIA IndeX rendering. A 2D ellipse represents a screen-space shape commonly used to annotating a scene or to build widgets. The ellipse is defined in image space, i.e., an ellipse is parallel to the view plane and always faces towards the viewer. More...
 
class  IEllipsoid
 The set of higher-level 3D shapes part of the NVIDIA IndeX library include a 3D ellipsoid. A 3D ellipsoid is defined by its center and three orthogonal radii. The center and radii are defined in the ellipsoid's local coordinate system. The surface of the ellipsoid is shaded using the material and light defined in the scene description. More...
 
class  IError
 The base class of all errors generated by NVIDIA IndeX. All errors contain information about the host and potentially the GPU device that caused the error. Additionally, each error provides a descriptive error string detailing the error type and possible causes for the failure. More...
 
class  IOut_of_memory_error
 The base class for out-of-memory errors generated by NVIDIA IndeX. This class of errors contains additional information regarding the available memory resources and the size of the memory allocation request causing the runtime failure. The specializations of this class IHost_out_of_memory_error and IDevice_out_of_memory_error indicate the host or GPU-device memory system as the source of the resource allocation failure. More...
 
class  IHost_out_of_memory_error
 This class specializes the generic out-of-memory error interface (IOut_of_memory_error) to indicate the host memory system as the source of the resource allocation failure. More...
 
class  IDevice_out_of_memory_error
 This class specializes the generic out-of-memory error interface (IOut_of_memory_error) to indicate the GPU-device memory system as the source of the resource allocation failure. More...
 
class  IDevice_execution_error
 This error interface specialization indicates a failure to execute a GPU-device kernel at runtime. The causes for such errors suggest invalid memory accesses and will invalidate all device memory preventing further use of the associated GPU device of the current rendering process. More...
 
class  IRuntime_error
 This error interface specialization indicates general runtime failures. The provided error string will give more details about the runtime failure. More...
 
class  IError_set
 This class serves as a collection of runtime errors potentially generated during the execution of distributed NVIDIA IndeX processes such as multi-GPU or cluster-based rendering. More...
 
class  ITrace_event_iterator
 
class  ITrace_collection
 
class  ITrace_collection_handler
 
class  IEvent_tracing
 
class  IFont
 A font attribute describes the appearance of a label in the scene description. More...
 
class  IHeight_field_scene_element
 Interface for height field volume scene elements. More...
 
class  IHeight_field_subset_data_descriptor
 Subset-data descriptor for tiled height-field subsets. This interface class is used by the NVIDIA IndeX library to communicate information about tiled height-field sub-data to an application. More...
 
class  IHeight_field_subset
 Distributed data storage class for height-field subsets. More...
 
class  IHeightfield_interaction
 Abstract base class enabling heightfield related workflow functionality. More...
 
class  IHeightfield_pick_result
 Interface class that returns the heightfield specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to IHeightfield scene elements. More...
 
class  IIcon_3D
 Icons are common means for annotating a 3D scene using images. The 3D icon is defined in 3D space and its orientation is affected by the transformations applied by the scene description. The size is defined in 3D object space length. More...
 
class  IIcon_2D
 Icons are common means for annotating a 3D scene using images. The 2D icon is defined in image space and always faces towards the viewer, similar to a billboard; the label is parallel to the view plane. The size is defined in 2D image space (screen space) in pixel. More...
 
class  IIndex_canvas
 Enables rendering to a user-defined canvas. Technically, the canvas wraps a frame buffer that contains one or more rendering targets or frame buffer layer. The NVIDIA IndeX library renders its rendering/visualization results into the associated frame buffer layers. Typical use cases include the rendering (blending) of all image tiles (a.k.a. horizontal spans) into an OpenGL framebuffer, into main memory or CUDA buffer for video-streaming, and into an image buffer or file. More...
 
class  IIndex_cuda_canvas
 CUDA-memory based canvas. Using a CUDA-memory based enables NVIDIA IndeX to run rendering and image compositing on the GPU only without ever transferring data from GPUs to main memory. NVIDIA IndeX support the creation of a built-in CUDA canvas that derives from the following interface class. More...
 
class  Index_cuda_canvas
 Application managed interface class of a CUDA canvas implemented inside the NVIDIA IndeX library. More...
 
class  Index_canvas
 Mixin class for implementing the IIndex_canvas interface. More...
 
class  IIndex_debug_configuration
 Interface to set debug options for the NVIDIA IndeX library. More...
 
class  IIndex_scene_query
 Interface class that enables application writers to query the scene's contents. Scene queries include, for instance, the pick operation, which is the task of determining which rendered scene element a user has clicked on, or entry lookup, which returns a single entry of a dataset. More...
 
class  IInference_result
 Interface class representing AI/DL inference results to be consumed by NVIDIA IndeX. More...
 
class  IInference_source_data
 Interface class exposes the source data that an inference technique can operate on. More...
 
class  IIntersection_highlight_pick_result
 Interface class that returns the pick result specific to the intersection highlighting. More...
 
class  IIntersection_highlighting
 Enables the highlighting of an intersection with another shape on the surface of the current shape. For example, when this attribute is applied to an IPlane shape and the intersection shape is set to an IRegular_heightfield, then the intersection between the plane and the heightfield will be shown on the surface of the plane. More...
 
class  IIrregular_volume_compute_task
 Interface class for a volume compute tasks operating on the voxel values of one irregular volume data. More...
 
class  Irregular_volume_compute_task
 Mixin class for implementing the IIrregular_volume_compute_task interface. More...
 
class  IIrregular_volume_rendering_properties
 Interface representing rendering properties for irregular volumes. More...
 
class  IIrregular_volume_scene_element
 Interface for irregular volume scene elements. More...
 
class  IIrregular_volume_subset
 Distributed data storage class for irregular volume subsets. More...
 
class  ILabel_layout
 A label layout defined a label's appearance including, for instance, the padding around the test and the foreground and background colors. More...
 
class  ILabel_3D
 A label defined in object space. The orientation of the label is affected by the transformations applied by the scene description. The dimension (position, height, ...) is defined in the 3D object space. More...
 
class  ILabel_2D
 A label defined in image space. The label always faces towards the viewer, i.e., the label is parallel to the view plane. ILabel_2D is a part of the scene description. The dimension (position, height, ...) is defined in the 2D image space (2D screen space). More...
 
class  ILight
 The light base class. Derived classes define the light sources. Light sources emit light into the scene and enable the rendering system to shade graphics elements such as heightfields or higher-level 3D shapes in a realistic way. The illumination of surfaces using light sources provides visual cues in the scene and enables users of the rendering software to orient themselves in 3D space. More...
 
class  IDirectional_light
 An interface class representing a directional light. A directional light source illuminates all graphics elements equally from a given direction; it defines an oriented light with an origin at infinity. That is, a directional light source has a directional vector and parallel light rays travel along the direction. The directional light contributes to diffuse and specular reflections but does not contribute to ambient reflections. More...
 
class  IDirectional_headlight
 A directional headlight is just like a normal directional light, just the light direction is specified in eye space instead of object space. This means that the light source will move with the camera, giving the impression of a "headlight" that is fixed to the camera. More...
 
class  ILine_set
 Interface class for line geometry, which is a scene element and can be added to the scene description. A line set is a set of line segments. Each segment has its own color and width/radius. More...
 
class  ILine_set_pick_result
 Interface class that returns the line set specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to ILine_set scene elements. More...
 
class  IMaterial
 The material base class. Derived classes define the material properties of shapes. The material properties are applied to shapes together with the direct illumination using light sources. The material properties, e.g., the ambient, diffuse, and specular surface reflectivity, the shininess of the surface and its transparency shall be defined by a material attribute as part of the scene description. Only one material property can be active at the same time. All graphics elements that are affected by the material shall then be shaded in accordance to the material properties. More...
 
class  IPhong_gl
 An interface class representing a simple OpenGL material property. More...
 
class  ICuda_memory_buffer
 Interface class encapsulating and exposing CUDA device memory. More...
 
class  ICuda_memory_manager
 Interface class for allocating NVIDIA IndeX library-side buffers for use also on the application-side. More...
 
class  IMemory_manager
 Interface class for allocating NVIDIA IndeX library-side buffers for use also on the application-side. More...
 
class  IOpengl_application_buffer
 OpenGL z-buffer maintained by the application. More...
 
class  IParticle_volume_rendering_properties
 The interface class representing rendering properties for particle volume data. More...
 
class  IParticle_volume_scene_element
 Interface for particle volume scene elements. More...
 
class  IParticle_volume_attribute_set_descriptor
 Attribute-set descriptor for particle volume subsets. This interface is used to configure a set of attributes for a particle volume subset to input into the NVIDIA IndeX library. More...
 
class  IParticle_volume_subset
 Distributed data storage class for particle volume subsets. More...
 
class  IPath_style
 Interface class representing the styles that can be applied to a path. Currently, the style merely defines the interpolation technique. Only one style can be active at a time. More...
 
class  IPath_3D
 Interface class for 3D paths. The path is represented by a collection of 3D points connected by an unique and continuous line path. Every point contains data represented as colors. More...
 
class  IPath_2D
 Interface class for 2D paths. The path is represented by a collection of 3D points connected by an unique and continuous line path. Every point contains data represented as colors. More...
 
class  IPath_pick_result
 Interface class that represents the path-specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to IPath_2d or IPath_3d scene elements. In the future, the path specific pick result interface class may be extended by a derived interface class that returns 3D related pick information such as the normal or 1D/2D-texture coordinates at an intersection point. More...
 
class  IPath_lookup_result
 Interface class that represents the path specific entry lookup result. The interface class sub classes from IScene_lookup_result to provide additional results related to an entry of a IPath_2d or IPath_3d scene elements. Each entry or lookup index refers to a single vertex of the path and the values stored along with the vertex, such as the per-vertex color or the radius. More...
 
class  IPer_span_statistics
 Interface class that exposes the performance values and statistics of a single horizontal span. More...
 
class  IPerformance_values
 Interface class to query overall system performance values and statistics. More...
 
class  IPipe_set
 Pipe set. More...
 
class  IPipe_subset_parameters
 Helper for setting the parameters of a single pipe inside a subset. An instance of this interface is returned by IPipe_set_subset::add_pipe(). More...
 
class  IPipe_set_subset
 Distributed data storage for pipe sets. More...
 
class  IPlane
 Interface class representing a rectangular cutout of an infinite plane as part of the scene description. More...
 
class  IPlane_pick_result
 Interface class that returns the plane specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to IPlane scene elements. More...
 
class  IPoint_set
 Interface class for a point set, which is a scene element and can be added the scene description. Each point has its own color and radius. More...
 
class  IPoint_set_pick_result
 Interface class that returns the point set specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to IPoint_set scene elements. More...
 
class  IPolygon
 A polygon of n vertices defined in image space. The polygon always faces towards the viewer, i.e., the polygon is parallel to the view plane. More...
 
class  IProgress_callback
 The interface class allows implementing user-defined progress callbacks used for querying the progress of the distributed rendering or computing task. The progress of a tasks, e.g., the uploading and rendering of the data, is measured in percent in the range from 0 to 100. More...
 
class  IHeightfield_geometry_settings
 Scene attribute to control the rendering of embedded heightfield geometry. The embedded geometry is closely associated with the heightfield, but rendered separately. This attribute allows to control which of the different types of embedded geometry should be shown and how they should be visualized. More...
 
class  IRegular_heightfield
 The abstract interface class representing a heightfield scene element. More...
 
class  IRegular_heightfield_compute_task
 Interface class for heightfield compute tasks that operate on the elevation values of one heightfield patch. More...
 
class  IRegular_heightfield_patch
 Distributed data storage class for regular heightfield scene elements. More...
 
class  IRegular_heightfield_rendering_properties
 The interface class representing rendering properties for regular height-field data. More...
 
class  IRendering_kernel_program
 The interface class representing user-programmable rendering kernel components. More...
 
class  IRendering_kernel_program_headers
 Defines headers that can be included by rendering kernel programs. The attribute is applied to a scene element and then affects any IRendering_kernel_program that is also applied. More...
 
class  IRendering_kernel_program_parameters
 The interface class representing user-defined parameter buffers for user-programmable rendering kernel components. More...
 
class  IRendering_kernel_program_scene_element_mapping
 Scene attribute to map scene elements to slots that are accessible by user-programmable rendering kernel components. More...
 
class  IVolume_sample_program
 An interface class representing rendering kernel programs applied to volume primitives (e.g., ISparse_volume_scene_element). More...
 
class  ISurface_sample_program
 An interface class representing rendering kernel programs applied to surface primitives (e.g., IRegular_heightfield). More...
 
class  IRendering_order
 IRendering_order defines a rendering priority for the raster shapes following in the scene description. More...
 
class  IRay_sampling
 Interface to perform ray sampling. More...
 
class  IRay_sampling_value_format
 Interface to define user values for ray sampling the scene's contents. More...
 
class  IRay_sampling_query
 Interface to define a query for ray sampling the scene's contents. More...
 
class  IRay_sampling_object_info
 Interface to access information about the sampled object. More...
 
class  IRay_sampling_result
 Interface to access result of ray sampling the scene's contents. More...
 
class  IScene
 The abstract interface class representing the entire scene. The scene is also the root node of the scene description and therefore implements the IScene_group interface. More...
 
class  IScene_convenience_manipulation
 An interface class that provides a convenient way to change commonly used scene manipulations. More...
 
class  IScene_element
 The interface class represents scene elements. Implementations of the interface class represent, for example, shapes and attributes in the scene. An IScene_element is a part of the scene description. More...
 
class  IScene_group
 A scene group allows structuring a scene in a hierarchical form. Every scene group may contain a list of scene elements referenced by tags. A scene element can be a shape (e.g., a sphere), an attribute (e.g., a material), or other scene groups. Scene groups that contains other scene groups create a hierarchical scene description. More...
 
class  ITransformed_scene_group
 A transformed scene group is used in the typical manner for structuring the scene but also defines a transformation matrix which will be applied to all of its children. Transformations are inherited down through the hierarchy represented by nested scene groups. More...
 
class  IStatic_scene_group
 A static scene group is used in the typical manner for structuring the scene but does not maintain its own transformation matrix. More...
 
class  IShape_scene_group
 A shape scene group (or simply "shape group") aggregates multiple scene elements to create new user-defined geometry objects. The shape group only stores the geometry; its contents are created and modified by an associated IShape_scene_group_manipulator. More...
 
class  IShape_scene_group_manipulator
 An implementation of IShape_scene_group_manipulator creates user-defined geometry by filling an IShape_scene_group with scene elements. Additional methods may be added to modify the contents of an existing shape group. More...
 
class  IScene_path
 Describes a path through the scene description to identify a specific instance of a scene element. More...
 
class  IScene_pick_result
 Interface class that returns the result of a pick operation. The interface class represents a single scene query result generated by a mouse over operation (a.k.a. 'pick' operation), i.e., by a ray starting from the scene's camera position cast through the scene. More...
 
class  IScene_pick_results
 Interface class that returns all results of a pick operation in front-to-back order. The interface class enables accessing all scene query result generated by a mouse over operation (cf. IScene_pick_result). The mouse over operation computes all intersections of the cast ray with the scene elements and all query results are sorted in front to depth order in accordance to the camera position. More...
 
class  IScene_pick_results_list
 Defines a list of pick results. Each of these pick results can store multiple intersections. More...
 
class  IScene_lookup_result
 Interface class that returns the result of a entry lookup operation. The interface class represents a single scene query result generated by a mouse over operation (a.k.a. 'pick' operation), i.e., by a ray starting from the scene's camera position cast through the scene. More...
 
class  IScene_visitor
 Enables user-specific evaluations of the scene representation. More...
 
class  ISession
 The abstract interface class representing a working session with the system. Such a session contains a configuration (IConfig_settings) and an scene (IScene). More...
 
class  IShading_model
 The interface class representing a shading model. More...
 
class  IFlat_shading
 An interface class representing flat shading. More...
 
class  IPhong_shading
 An interface class representing Phong shading. More...
 
class  IShape
 The base class of all shapes. A shape can either be defined in object space or in image space. All types of shapes can be pickable. More...
 
class  IObject_space_shape
 Object space shapes are defined in the 3D scene, i.e., their position as well as their extent is affected by the applied transformations present in the scene description. More...
 
class  IImage_space_shape
 Image space shapes have an extent defined in two-dimensional image space even though their position may be affected by the applied transformations present in the scene description. For instance, points, lines, and labels may have their vertex position defined in 3D space, but their width is defined in pixels. More...
 
class  ISlice_scene_element
 Interface class representing slice scene elements as part of the scene description, i.e., in IScene. More...
 
class  ISection_scene_element
 The abstract interface class representing section slices in the scene description. Section slices represent axis-aligned planes defined and positioned in a volume's local IJK space. More...
 
class  IVertical_profile_scene_element
 The abstract interface class representing multi-segment vertical profiles in the scene description. Multi-segment vertical profiles represent connected line segments that are defined in the volume's local IJ space and are extruded along the vertical axis covering the volume's IJK extent. More...
 
class  ISparse_volume_compute_task
 Interface class for a volume compute tasks operating on a sparse-volume subset. More...
 
class  ISparse_volume_rendering_properties
 The interface class representing rendering properties for sparse volume data. More...
 
class  ISparse_volume_scene_element
 Interface for sparse volume scene elements. More...
 
class  IVolume_device_data_buffer
 Volume device-data accessor interface. More...
 
class  ISparse_volume_attribute_set_descriptor
 Attribute-set descriptor for sparse volume subsets. This interface is used to configure a set of attributes for a sparse volume subset to input into the NVIDIA IndeX library. More...
 
class  ISparse_volume_subset_data_descriptor
 Subset-data descriptor for sparse volume subsets. This interface class is used by the NVIDIA IndeX library to communicate information about sparse volume sub-data to an application. NVIDIA IndeX is storing sparse volume data in a bricked format internally. This interface class gives detailed information about volume-brick data contained in the subset. The application is free to fill volume-data bricks or leave them empty, hence creating a sparse volume layout. More...
 
class  ISparse_volume_subset
 Distributed data storage class for sparse volume subsets. More...
 
class  ISphere
 A simple sphere. More...
 
class  ITexture
 A base class that defines the properties of a texture of resolution [x,y] for a given pixel format. The origin of the texture coordinate system is defined to be the lower-left corner. More...
 
class  ITexture_filter_mode
 The interface class representing a texture filter mode. More...
 
class  ITexture_filter_mode_nearest_neighbor
 An interface class representing nearest-neighbor texture filtering. More...
 
class  ITexture_filter_mode_linear
 An interface class representing linear texture filtering. More...
 
class  IClock_pulse_generator
 The interface class IClock_pulse_generator generates the time for playing animations. More...
 
class  ITime_step_assignment
 The interface class ITime_step_assignment maps absolute time to time steps (or key frames). More...
 
class  ITriangle_mesh_pick_result
 Interface class that returns the triangle mesh specific result of a pick operation/query. The interface class sub classes from IScene_pick_result to provide additional intersection results specific to ITriangle_mesh_scene_element. More...
 
class  ITriangle_mesh_lookup_result
 Interface class that returns the triangle mesh specific result of a query operation. The interface class sub classes from IScene_lookup_result to provide additional results related to an entry of a ITriangle_mesh_scene_element elements. Each entry or lookup index refers to a single triangle of the triangle mesh and the per-vertex attributes stored along with the triangle, such as the per-vertex colors. The lookup result provides the per-vertex values in counter-clockwise order. More...
 
class  ITriangle_mesh_scene_element
 Triangle mesh interface class that represents a large-scale triangle mesh in the scene description. More...
 
class  ITriangle_mesh_subset
 Defines the vertices and per-vertex attributes of a subset of a triangle mesh. More...
 
class  IVDB_rendering_properties
 The interface class representing rendering properties for VDB data. More...
 
class  IVDB_scene_element
 Interface for VDB scene elements. More...
 
class  IVDB_subset
 Distributed data storage class for VDB subsets. More...
 
class  IViewport
 A viewport defines a two-dimensional area of a canvas where the scene from a given DiCE scope should be rendered. Creating multiple views allows to render the same scene or multiple scenes with modifications side-by-side to one canvas. More...
 
class  IViewport_list
 Defines a list of viewports that will be rendered onto a canvas. More...
 
class  ICanvas_viewport_list
 Defines a list of canvases with associated viewports. This allows rendering to multiple canvases, each having one or more viewports. More...
 
class  IWireframe_rendering_style
 The interface class representing an attribute to render triangle based geometries in wireframe style. The class provides two different styles: outline and wireframe. More...
 
class  IHeightfield_wireframe_style
 The interface class representing the wireframe style specific to heightfields. More...
 

Typedefs

typedef mi::Uint32 IFrame_identifier
 A frame's unique identifier. More...
 

Enumerations

enum  Distributed_data_attribute_format {
  ATTRIB_FORMAT_UINT8 = 0x00u, ATTRIB_FORMAT_UINT8_2, ATTRIB_FORMAT_UINT8_3, ATTRIB_FORMAT_UINT8_4,
  ATTRIB_FORMAT_SINT8, ATTRIB_FORMAT_SINT8_2, ATTRIB_FORMAT_SINT8_3, ATTRIB_FORMAT_SINT8_4,
  ATTRIB_FORMAT_UINT16, ATTRIB_FORMAT_UINT16_2, ATTRIB_FORMAT_UINT16_3, ATTRIB_FORMAT_UINT16_4,
  ATTRIB_FORMAT_SINT16, ATTRIB_FORMAT_SINT16_2, ATTRIB_FORMAT_SINT16_3, ATTRIB_FORMAT_SINT16_4,
  ATTRIB_FORMAT_UINT32, ATTRIB_FORMAT_UINT32_2, ATTRIB_FORMAT_UINT32_3, ATTRIB_FORMAT_UINT32_4,
  ATTRIB_FORMAT_SINT32, ATTRIB_FORMAT_SINT32_2, ATTRIB_FORMAT_SINT32_3, ATTRIB_FORMAT_SINT32_4,
  ATTRIB_FORMAT_FLOAT16, ATTRIB_FORMAT_FLOAT16_2, ATTRIB_FORMAT_FLOAT16_3, ATTRIB_FORMAT_FLOAT16_4,
  ATTRIB_FORMAT_FLOAT32, ATTRIB_FORMAT_FLOAT32_2, ATTRIB_FORMAT_FLOAT32_3, ATTRIB_FORMAT_FLOAT32_4,
  ATTRIB_FORMAT_COUNT, ATTRIB_FORMAT_INVALID = ATTRIB_FORMAT_COUNT
}
 Attribute formats for distributed data. More...
 
enum  ITrace_event_type {
  NONE = 0, VALUE_U64, VALUE_S64, VALUE_F64,
  VALUE_DURATION, NEW_NS, CLEAR_NS
}
 
enum  Particle_volume_render_mode {
  PARTICLE_VOLUME_RENDER_MODE_RBF = 0x00u, PARTICLE_VOLUME_RENDER_MODE_SOLID_BOX, PARTICLE_VOLUME_RENDER_MODE_SOLID_CONE, PARTICLE_VOLUME_RENDER_MODE_SOLID_CYLINDER,
  PARTICLE_VOLUME_RENDER_MODE_SOLID_SPHERE, PARTICLE_VOLUME_RENDER_MODE_SOLID_INDIVIDUAL, PARTICLE_VOLUME_RENDER_MODE_COUNT
}
 Available rendering modes for particle volume elements. More...
 
enum  Particle_volume_RBF_falloff_kernel {
  PARTICLE_VOLUME_RBF_FALLOFF_CONSTANT = 0x00, PARTICLE_VOLUME_RBF_FALLOFF_LINEAR, PARTICLE_VOLUME_RBF_FALLOFF_HERMITE, PARTICLE_VOLUME_RBF_FALLOFF_SPLINE,
  PARTICLE_VOLUME_RBF_FALLOFF_COUNT
}
 Available radial basis-functions for the direct volume rendering mode of particle volume primitives. These define the falloff of the influence of a particle over its volume of influence defined by its radius. More...
 
enum  Sparse_volume_filter_mode {
  SPARSE_VOLUME_FILTER_NEAREST = 0x00, SPARSE_VOLUME_FILTER_TRILINEAR_POST = 0x01, SPARSE_VOLUME_FILTER_TRILINEAR_PRE = 0x02, SPARSE_VOLUME_FILTER_TRICUBIC_CATMULL_POST = 0x03,
  SPARSE_VOLUME_FILTER_TRICUBIC_CATMULL_PRE = 0x04, SPARSE_VOLUME_FILTER_TRICUBIC_BSPLINE_POST = 0x05, SPARSE_VOLUME_FILTER_TRICUBIC_BSPLINE_PRE = 0x06
}
 Filtering modes (interpolation) for sparse volume access. More...
 
enum  Sparse_volume_voxel_format {
  SPARSE_VOLUME_VOXEL_FORMAT_UINT8 = 0x00, SPARSE_VOLUME_VOXEL_FORMAT_UINT8_2, SPARSE_VOLUME_VOXEL_FORMAT_UINT8_4, SPARSE_VOLUME_VOXEL_FORMAT_SINT8,
  SPARSE_VOLUME_VOXEL_FORMAT_SINT8_2, SPARSE_VOLUME_VOXEL_FORMAT_SINT8_4, SPARSE_VOLUME_VOXEL_FORMAT_UINT16, SPARSE_VOLUME_VOXEL_FORMAT_UINT16_2,
  SPARSE_VOLUME_VOXEL_FORMAT_UINT16_4, SPARSE_VOLUME_VOXEL_FORMAT_SINT16, SPARSE_VOLUME_VOXEL_FORMAT_SINT16_2, SPARSE_VOLUME_VOXEL_FORMAT_SINT16_4,
  SPARSE_VOLUME_VOXEL_FORMAT_FLOAT16, SPARSE_VOLUME_VOXEL_FORMAT_FLOAT16_2, SPARSE_VOLUME_VOXEL_FORMAT_FLOAT16_4, SPARSE_VOLUME_VOXEL_FORMAT_FLOAT32,
  SPARSE_VOLUME_VOXEL_FORMAT_FLOAT32_2, SPARSE_VOLUME_VOXEL_FORMAT_FLOAT32_4, SPARSE_VOLUME_VOXEL_FORMAT_COUNT
}
 Voxel format of sparse volume voxel data. More...
 

Functions

mi::Size get_sizeof (const nv::index::Sparse_volume_voxel_format fmt)
 

Detailed Description

Namespace for NVIDIA IndeX library APIs.

Typedef Documentation

A frame's unique identifier.

Enumeration Type Documentation

Enumerator
NONE 
VALUE_U64 
VALUE_S64 
VALUE_F64 
VALUE_DURATION 
NEW_NS 
CLEAR_NS 

Function Documentation

mi::Size nv::index::get_sizeof ( const nv::index::Sparse_volume_voxel_format  fmt)
inline