MDL SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::IBaker Class Referenceabstract

Allows to bake a varying or uniform expression of a compiled material into a texture or constant. More...

#include <imdl_distiller_api.h>

Inheritance diagram for mi::neuraylib::IBaker:

Public Member Functions

virtual const char * get_pixel_type () const =0
 Returns the pixel type that matches the expression to be baked best. More...
 
virtual bool is_uniform () const =0
 Indicates whether the expression to be baked is uniform or varying. More...
 
virtual Sint32 bake_texture (ICanvas *texture, Uint32 samples=1) const =0
 Bakes the expression as texture. More...
 
virtual Sint32 bake_texture (ICanvas *texture, Float32 min_u, Float32 max_u, Float32 min_v, Float32 max_v, Uint32 samples=1) const =0
 Bakes the expression as texture. More...
 
virtual Sint32 bake_constant (IData *constant, Uint32 samples=1) const =0
 Bakes the expression as constant. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x4dba1b1d, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x4dba1b1d, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

Allows to bake a varying or uniform expression of a compiled material into a texture or constant.

Member Function Documentation

 bake_constant()

virtual Sint32 mi::neuraylib::IBaker::bake_constant ( IData constant,
Uint32  samples = 1 
) const
pure virtual

Bakes the expression as constant.

Parameters
constantAn instance of mi::IData of suitable type such that the baked constant can be stored in this argument. For pixel types "Float32" and "Float32<3>" the type name of this argument needs to match the pixel type. For pixel type "Rgb_fp" this argument needs to have the type name "Color".
samplesThe (total) number of samples.
Returns
  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: The transaction that is bound to this baker is no longer open.
  • -3: The execution of the MDL code failed.
  • -4: The type of constant does not match the pixel type corresponding to the expression to be baked.

 bake_texture() [1/2]

virtual Sint32 mi::neuraylib::IBaker::bake_texture ( ICanvas texture,
Float32  min_u,
Float32  max_u,
Float32  min_v,
Float32  max_v,
Uint32  samples = 1 
) const
pure virtual

Bakes the expression as texture.

Parameters
textureThe baked texture will be stored in this canvas. If the pixel type of canvas does not match the pixel type of the expression to be baked (as indicated by get_pixel_type()), then the pixel data is converted as described in mi::neuraylib::IImage_api::convert().
min_uThe lower value of the U range used for baking.
max_uThe higher value of the U range used for baking.
min_vThe lower value of the V range used for baking.
max_vThe higher value of the V range used for baking.
samplesThe number of samples (per pixel).
Returns
  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: The transaction that is bound to this baker is no longer open.
  • -3: The execution of the MDL code failed.

 bake_texture() [2/2]

virtual Sint32 mi::neuraylib::IBaker::bake_texture ( ICanvas texture,
Uint32  samples = 1 
) const
pure virtual

Bakes the expression as texture.

Parameters
textureThe baked texture will be stored in this canvas. If the pixel type of canvas does not match the pixel type of the expression to be baked (as indicated by get_pixel_type()), then the pixel data is converted as described in mi::neuraylib::IImage_api::convert().
samplesThe number of samples (per pixel).
Returns
  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: The transaction that is bound to this baker is no longer open.
  • -3: The execution of the MDL code failed.

 get_pixel_type()

virtual const char * mi::neuraylib::IBaker::get_pixel_type ( ) const
pure virtual

Returns the pixel type that matches the expression to be baked best.

 is_uniform()

virtual bool mi::neuraylib::IBaker::is_uniform ( ) const
pure virtual

Indicates whether the expression to be baked is uniform or varying.

Typically, varying expressions are baked into textures, and uniform expressions into constant. However, it is also possible to do it the other way round.