nv::index::IRay_sampling Class Reference

Interface to perform ray sampling. More...

#include <isampling_rays.h>

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

Public Types
enum	Limit {   MAX_RAYS ,   MAX_USER_VALUES ,   MAX_USER_VALUE_SIZE }
	Limits for ray sampling. More...

Public Member Functions
virtual mi::Uint32	get_limit (Limit limit) const =0
	Returns the value for. More...
virtual IRay_sampling_value_format *	create_sampling_value_format ()=0
	Create object to specify a user value format for ray samples,. More...
virtual IRay_sampling_query *	create_sampling_query ()=0
	Create object to specify a ray sampling query,. More...
virtual const IRay_sampling_result *	sample_scene (const IRay_sampling_query *sampling_query, const IRay_sampling_value_format *user_value_format, IIndex_rendering *index_rendering, mi::neuraylib::Tag_struct session_tag, mi::neuraylib::IDice_transaction *transaction)=0
	Perform ray sampling on the scene. More...

Detailed Description

Interface to perform ray sampling.

Member Enumeration Documentation

Limit

enum nv::index::IRay_sampling::Limit

Limits for ray sampling.

Enumerator
MAX_RAYS	maximum number of rays to be sampled at once, at least 4
MAX_USER_VALUES	maximum number of user defined sample values, in range [4,32]
MAX_USER_VALUE_SIZE	maximum byte size of one sample value, at least 64

Member Function Documentation

create_sampling_query()

virtual IRay_sampling_query * nv::index::IRay_sampling::create_sampling_query ( )

pure virtual

Create object to specify a ray sampling query,.

See also

IRay_sampling_query.

create_sampling_value_format()

virtual IRay_sampling_value_format * nv::index::IRay_sampling::create_sampling_value_format ( )

pure virtual

Create object to specify a user value format for ray samples,.

See also

IRay_sampling_value_format.

get_limit()

virtual mi::Uint32 nv::index::IRay_sampling::get_limit ( Limit  limit ) const

pure virtual

Returns the value for.

Parameters

limit

sample_scene()

virtual const IRay_sampling_result * nv::index::IRay_sampling::sample_scene ( const IRay_sampling_query *  sampling_query, const IRay_sampling_value_format *  user_value_format, IIndex_rendering *  index_rendering, mi::neuraylib::Tag_struct  session_tag, mi::neuraylib::IDice_transaction *  transaction  )

pure virtual

Perform ray sampling on the scene.

Parameters

[in]	sampling_query	The sampling query specifying the ray(s) and sampling limits.
[in]	user_value_format	Specification of the user value format, can be NULL.
[in]	index_rendering	Instance of the rendering interface
[in]	session_tag	The ISession tag.
[in]	transaction	DiCE transaction.

Returns

The sampling result,

See also

IRay_sampling_result.

---

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

• isampling_rays.h