7#ifndef MI_NEURAYLIB_TARGET_CODE_TYPES_H
8#define MI_NEURAYLIB_TARGET_CODE_TYPES_H
13#if defined(TARGET_CODE_USE_CUDA_TYPES) && defined(TARGET_CODE_USE_NEURAY_TYPES)
14#error "Only one of TARGET_CODE_USE_CUDA_TYPES and TARGET_CODE_USE_NEURAY_TYPES may be defined."
17#if !defined(TARGET_CODE_USE_NEURAY_TYPES) && \
18 (defined(TARGET_CODE_USE_CUDA_TYPES) || defined(__CUDA_ARCH__))
20#include <vector_types.h>
92template<
bool with_derivatives>
102 using tct_coord2_type =
const tct_float[2];
112 using tct_coord2_type =
const tct_derivable_float2 *;
200template<
bool with_derivatives = false>
331struct Texture_handler_base;
336template<
bool with_derivatives = false>
342 void (*m_tex_lookup_float4_2d)(
346 typename traits::tct_coord2_type coord,
354 void (*m_tex_lookup_float3_2d)(
358 typename traits::tct_coord2_type coord,
366 void (*m_tex_texel_float4_2d)(
375 void (*m_tex_lookup_float4_3d)(
389 void (*m_tex_lookup_float3_3d)(
403 void (*m_tex_texel_float4_3d)(
411 void (*m_tex_lookup_float4_cube)(
418 void (*m_tex_lookup_float3_cube)(
427 void (*m_tex_resolution_2d)(
437 void (*m_tex_resolution_3d)(
477 void (*m_df_light_profile_sample)(
499 void (*m_df_bsdf_measurement_resolution)(
506 void (*m_df_bsdf_measurement_evaluate)(
515 void (*m_df_bsdf_measurement_sample)(
534 void (*m_df_bsdf_measurement_albedos)(
546 void (*m_adapt_normal)(
567 void (*m_scene_data_lookup_float2)(
576 void (*m_scene_data_lookup_float3)(
585 void (*m_scene_data_lookup_float4)(
602 void (*m_scene_data_lookup_int2)(
607 tct_int const default_value[2],
611 void (*m_scene_data_lookup_int3)(
616 tct_int const default_value[3],
620 void (*m_scene_data_lookup_int4)(
625 tct_int const default_value[4],
629 void (*m_scene_data_lookup_color)(
639 void (*m_scene_data_lookup_float4x4)(
652 void (*m_scene_data_lookup_deriv_float)(
661 void (*m_scene_data_lookup_deriv_float2)(
670 void (*m_scene_data_lookup_deriv_float3)(
679 void (*m_scene_data_lookup_deriv_float4)(
688 void (*m_scene_data_lookup_deriv_color)(
735 BSDF_EVENT_ABSORB = 0,
737 BSDF_EVENT_DIFFUSE = 1,
738 BSDF_EVENT_GLOSSY = 1 << 1,
739 BSDF_EVENT_SPECULAR = 1 << 2,
740 BSDF_EVENT_REFLECTION = 1 << 3,
741 BSDF_EVENT_TRANSMISSION = 1 << 4,
743 BSDF_EVENT_DIFFUSE_REFLECTION =
BSDF_EVENT_DIFFUSE |
BSDF_EVENT_REFLECTION,
744 BSDF_EVENT_DIFFUSE_TRANSMISSION =
BSDF_EVENT_DIFFUSE |
BSDF_EVENT_TRANSMISSION,
745 BSDF_EVENT_GLOSSY_REFLECTION =
BSDF_EVENT_GLOSSY |
BSDF_EVENT_REFLECTION,
746 BSDF_EVENT_GLOSSY_TRANSMISSION =
BSDF_EVENT_GLOSSY |
BSDF_EVENT_TRANSMISSION,
747 BSDF_EVENT_SPECULAR_REFLECTION =
BSDF_EVENT_SPECULAR |
BSDF_EVENT_REFLECTION,
748 BSDF_EVENT_SPECULAR_TRANSMISSION =
BSDF_EVENT_SPECULAR |
BSDF_EVENT_TRANSMISSION,
750 BSDF_EVENT_FORCE_32_BIT = 0xffffffffU
756#define MI_NEURAYLIB_BSDF_USE_MATERIAL_IOR (-1.0f)
763 DF_FLAGS_ALLOW_REFLECT = 1,
764 DF_FLAGS_ALLOW_TRANSMIT = 2,
765 DF_FLAGS_ALLOW_REFLECT_AND_TRANSMIT =
DF_FLAGS_ALLOW_REFLECT |
DF_FLAGS_ALLOW_TRANSMIT,
766 DF_FLAGS_ALLOWED_SCATTER_MODE_MASK =
DF_FLAGS_ALLOW_REFLECT_AND_TRANSMIT,
768 DF_FLAGS_FORCE_32_BIT = 0xffffffffU
803template<Df_handle_slot_mode N>
814 tct_float3 bsdf_diffuse[
static_cast<size_t>(N)];
816 tct_float3 bsdf_glossy[
static_cast<size_t>(N)];
825struct Bsdf_evaluate_data<
DF_HSM_POINTER> :
public Bsdf_evaluate_data_base
844struct Bsdf_evaluate_data<
DF_HSM_NONE> :
public Bsdf_evaluate_data_base
876template<Df_handle_slot_mode N>
886 tct_float3 albedo_diffuse[
static_cast<size_t>(N)];
888 tct_float3 albedo_glossy[
static_cast<size_t>(N)];
898struct Bsdf_auxiliary_data<
DF_HSM_POINTER> :
public Bsdf_auxiliary_data_base
919struct Bsdf_auxiliary_data<
DF_HSM_NONE> :
public Bsdf_auxiliary_data_base
949 char const *arg_block_data);
964 char const *arg_block_data);
979 char const *arg_block_data);
985struct Material_function
999 char const *arg_block_data);
1010 using Type_with_derivs = T(
1013 char const *arg_block_data);
1032 char const *arg_block_data);
1049 char const *arg_block_data);
1064 char const *arg_block_data);
1079 char const *arg_block_data);
1094 char const *arg_block_data);
1109 char const *arg_block_data);
1124 char const *arg_block_data);
1139 char const *arg_block_data);
1153 char const *arg_block_data);
1168 char const *arg_block_data);
1174 EDF_EVENT_EMISSION = 1,
1176 EDF_EVENT_FORCE_32_BIT = 0xffffffffU
1194template<Df_handle_slot_mode N>
1207struct Edf_evaluate_data<
DF_HSM_POINTER> :
public Edf_evaluate_data_base
1220struct Edf_evaluate_data<
DF_HSM_NONE> :
public Edf_evaluate_data_base
1238template<Df_handle_slot_mode N>
1250struct Edf_auxiliary_data<
DF_HSM_POINTER> :
public Edf_auxiliary_data_base
1262struct Edf_auxiliary_data<
DF_HSM_NONE> :
public Edf_auxiliary_data_base
1283 char const *arg_block_data);
1300 char const *arg_block_data);
1315 char const *arg_block_data);
1330 char const *arg_block_data);
1345 char const *arg_block_data);
1360 char const *arg_block_data);
1375 char const *arg_block_data);
1390 char const *arg_block_data);
1404 char const *arg_block_data);
1419 char const *arg_block_data);
int Sint32
32-bit signed integer.
Definition: types.h:46
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
Color cos(const Color &c)
Returns a color with the elementwise cosine of the color c.
Definition: color.h:546
math::Vector_struct<Float32, 2> Float32_2_struct
Vector of two Float32 (underlying POD type).
Definition: vector_typedefs.h:187
math::Vector_struct<Float32, 4> Float32_4_struct
Vector of four Float32 (underlying POD type).
Definition: vector_typedefs.h:201
math::Vector_struct<Float32, 3> Float32_3_struct
Vector of three Float32 (underlying POD type).
Definition: vector_typedefs.h:194
bool tct_bool
A bool.
Definition: target_code_types.h:81
float tct_float
A float.
Definition: target_code_types.h:61
void(void *result, Shading_state_environment const *state, Resource_data const *res_data, char const *arg_block_data) Environment_function
Signature of environment functions created via mi::neuraylib::IMdl_backend::translate_environment() a...
Definition: target_code_types.h:949
mi::Float32_4_struct tct_float4
A float4.
Definition: target_code_types.h:70
mi::Float32_2_struct tct_float2
A float2.
Definition: target_code_types.h:64
void(Edf_auxiliary_data_base *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Edf_auxiliary_function_with_derivs
Signature of the auxiliary function for material distribution functions created via mi::neuraylib::IM...
Definition: target_code_types.h:1419
void(Bsdf_auxiliary_data_base *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_auxiliary_function
Signature of the auxiliary function for material distribution functions created via mi::neuraylib::IM...
Definition: target_code_types.h:1153
Mbsdf_part
MBSDFs can consist of two parts, which can be selected using this enumeration.
Definition: target_code_types.h:321
tct_traits<true>::tct_derivable_float tct_deriv_float
A float with derivatives.
Definition: target_code_types.h:116
void(void *result, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Material_expr_function
Signature of material expression functions created via mi::neuraylib::IMdl_backend::translate_materia...
Definition: target_code_types.h:964
void(Bsdf_evaluate_data_base *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_evaluate_function_with_derivs
Signature of the evaluation function for material distribution functions created via mi::neuraylib::I...
Definition: target_code_types.h:1109
void(Edf_evaluate_data_base *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Edf_evaluate_function
Signature of the evaluation function for material distribution functions created via mi::neuraylib::I...
Definition: target_code_types.h:1345
Edf_event_type
The type of events created by EDF importance sampling.
Definition: target_code_types.h:1172
void(Edf_auxiliary_data_base *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Edf_auxiliary_function
Signature of the auxiliary function for material distribution functions created via mi::neuraylib::IM...
Definition: target_code_types.h:1404
void(Shading_state_material *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_init_function
Signature of the initialization function for material distribution functions created via mi::neurayli...
Definition: target_code_types.h:1032
void(Bsdf_sample_data *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_sample_function_with_derivs
Signature of the importance sampling function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1079
void(Edf_sample_data *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Edf_sample_function_with_derivs
Signature of the importance sampling function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1330
void(Shading_state_material_with_derivs *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_init_function_with_derivs
Signature of the initialization function for material distribution functions created via mi::neurayli...
Definition: target_code_types.h:1049
Tex_wrap_mode
The texture wrap modes as defined by tex::wrap_mode in the MDL specification.
Definition: target_code_types.h:302
mi::Float32_3_struct tct_float3
A float3.
Definition: target_code_types.h:67
void(Edf_evaluate_data_base *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Edf_evaluate_function_with_derivs
Signature of the evaluation function for material distribution functions created via mi::neuraylib::I...
Definition: target_code_types.h:1360
void(void *result, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Material_expr_function_with_derivs
Signature of material expression functions created via mi::neuraylib::IMdl_backend::translate_materia...
Definition: target_code_types.h:979
void(Bsdf_auxiliary_data_base *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_auxiliary_function_with_derivs
Signature of the auxiliary function for material distribution functions created via mi::neuraylib::IM...
Definition: target_code_types.h:1168
void(Bsdf_sample_data *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_sample_function
Signature of the importance sampling function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1064
Df_flags
Flags controlling the calculation of DF results.
Definition: target_code_types.h:760
mi::Sint32 tct_int
An int.
Definition: target_code_types.h:73
void(Edf_pdf_data *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Edf_pdf_function
Signature of the probability density function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1375
mi::Uint32 tct_uint
An unsigned int.
Definition: target_code_types.h:76
void(Shading_state_material_with_derivs *state, Resource_data const *res_data, char const *arg_block_data) Edf_init_function_with_derivs
Signature of the initialization function for material distribution functions created via mi::neurayli...
Definition: target_code_types.h:1300
void(Bsdf_pdf_data *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_pdf_function
Signature of the probability density function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1124
Bsdf_event_type
The type of events created by BSDF importance sampling.
Definition: target_code_types.h:734
tct_traits<true>::tct_derivable_float2 tct_deriv_float2
A float2 with derivatives.
Definition: target_code_types.h:119
void(Bsdf_evaluate_data_base *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_evaluate_function
Signature of the evaluation function for material distribution functions created via mi::neuraylib::I...
Definition: target_code_types.h:1094
void(Edf_pdf_data *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Edf_pdf_function_with_derivs
Signature of the probability density function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1390
Df_handle_slot_mode
Type of Bsdf_evaluate_data variants, depending on the backend and its configuration.
Definition: target_code_types.h:791
void(Edf_sample_data *data, Shading_state_material const *state, Resource_data const *res_data, char const *arg_block_data) Edf_sample_function
Signature of the importance sampling function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1315
void(Bsdf_pdf_data *data, Shading_state_material_with_derivs const *state, Resource_data const *res_data, char const *arg_block_data) Bsdf_pdf_function_with_derivs
Signature of the probability density function for material distribution functions created via mi::neu...
Definition: target_code_types.h:1139
tct_traits<true>::tct_derivable_float4 tct_deriv_float4
A float4 with derivatives.
Definition: target_code_types.h:125
void(Shading_state_material *state, Resource_data const *res_data, char const *arg_block_data) Edf_init_function
Signature of the initialization function for material distribution functions created via mi::neurayli...
Definition: target_code_types.h:1283
tct_traits<true>::tct_derivable_float3 tct_deriv_float3
A float3 with derivatives.
Definition: target_code_types.h:122
@ MBSDF_DATA_TRANSMISSION
the bidirectional transmission distribution function (BTDF)
Definition: target_code_types.h:326
@ MBSDF_DATA_REFLECTION
the bidirectional reflection distribution function (BRDF)
Definition: target_code_types.h:323
@ TEX_WRAP_CLIP
tex::wrap_clip: makes the texture lookup return zero for texture coordinates outside of the range
Definition: target_code_types.h:316
@ TEX_WRAP_MIRRORED_REPEAT
tex::wrap_mirrored_repeat: like wrap_repeat but takes one minus the fractional part every other inter...
Definition: target_code_types.h:312
@ TEX_WRAP_REPEAT
tex::wrap_repeat: takes the fractional part of the lookup coordinate effectively repeating the textur...
Definition: target_code_types.h:308
@ TEX_WRAP_CLAMP
tex::wrap_clamp: clamps the lookup coordinate to the range
Definition: target_code_types.h:304
@ DF_FLAGS_NONE
allows nothing -> black
Definition: target_code_types.h:761
@ DF_HSM_POINTER
Uses renderer defined buffers; not supported by all backends.
Definition: target_code_types.h:792
@ DF_HSM_FIXED_2
fixed size array for processing 2 handle at a time
Definition: target_code_types.h:795
@ DF_HSM_NONE
No slots, handles are ignored completely.
Definition: target_code_types.h:793
@ DF_HSM_FIXED_8
fixed size array for processing 8 handle at a time
Definition: target_code_types.h:797
@ DF_HSM_FIXED_1
fixed size array for processing 1 handle at a time
Definition: target_code_types.h:794
@ DF_HSM_FIXED_4
fixed size array for processing 4 handle at a time
Definition: target_code_types.h:796
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: example_derivatives.dox:5
Generic storage class template for math vector representations storing DIM elements of type T.
Definition: vector.h:135
Input and output structure for BSDF auxiliary calculation data.
Definition: target_code_types.h:874
Input and output structure for BSDF evaluation data.
Definition: target_code_types.h:801
Input and output structure for BSDF PDF calculation data.
Definition: target_code_types.h:861
tct_float3 ior2
mutual input: IOR other side
Definition: target_code_types.h:863
Df_flags flags
input: flags controlling calculation of result (optional depending on backend options)
Definition: target_code_types.h:869
tct_float3 k2
input: incoming direction
Definition: target_code_types.h:866
tct_float3 ior1
mutual input: IOR current medium
Definition: target_code_types.h:862
tct_float pdf
output: pdf (non-projected hemisphere)
Definition: target_code_types.h:867
tct_float3 k1
mutual input: outgoing direction
Definition: target_code_types.h:864
Input and output structure for BSDF sampling data.
Definition: target_code_types.h:773
tct_float4 xi
input: pseudo-random sample numbers in range [0, 1)
Definition: target_code_types.h:779
tct_float pdf
output: pdf (non-projected hemisphere)
Definition: target_code_types.h:780
Df_flags flags
input: flags controlling calculation of result (optional depending on backend options)
Definition: target_code_types.h:785
tct_int handle
output: handle of the sampled elemental BSDF (lobe)
Definition: target_code_types.h:783
tct_float3 ior2
mutual input: IOR other side
Definition: target_code_types.h:775
tct_float3 k1
mutual input: outgoing direction
Definition: target_code_types.h:776
tct_float3 k2
output: incoming direction
Definition: target_code_types.h:778
Bsdf_event_type event_type
output: the type of event for the generated sample
Definition: target_code_types.h:782
tct_float3 ior1
mutual input: IOR current medium
Definition: target_code_types.h:774
tct_float3 bsdf_over_pdf
output: bsdf * dot(normal, k2) / pdf
Definition: target_code_types.h:781
Input and output structure for EDF auxiliary calculation data.
Definition: target_code_types.h:1236
Input and output structure for EDF evaluation data.
Definition: target_code_types.h:1192
Input and output structure for EDF PDF calculation data.
Definition: target_code_types.h:1230
tct_float pdf
output: pdf (non-projected hemisphere)
Definition: target_code_types.h:1232
tct_float3 k1
input: outgoing direction
Definition: target_code_types.h:1231
Input and output structure for EDF sampling data.
Definition: target_code_types.h:1182
tct_int handle
output: handle of the sampled elemental EDF (lobe)
Definition: target_code_types.h:1188
tct_float3 k1
output: outgoing direction
Definition: target_code_types.h:1184
tct_float3 edf_over_pdf
output: edf * dot(normal,k1) / pdf
Definition: target_code_types.h:1186
tct_float pdf
output: pdf (non-projected hemisphere)
Definition: target_code_types.h:1185
tct_float4 xi
input: pseudo-random sample numbers in range [0, 1)
Definition: target_code_types.h:1183
Edf_event_type event_type
output: the type of event for the generated sample
Definition: target_code_types.h:1187
The data structure providing access to resources for generated code.
Definition: target_code_types.h:726
void const * shared_data
currently unused, should be nullptr
Definition: target_code_types.h:727
Texture_handler_base const * texture_handler
will be provided as "self" parameter to texture functions
Definition: target_code_types.h:728
The MDL environment state structure inside the MDL SDK is a representation of the renderer state in t...
Definition: target_code_types.h:151
tct_float3 direction
The result of state::direction().
Definition: target_code_types.h:154
char const * ro_data_segment
A pointer to a read-only data segment.
Definition: target_code_types.h:169
The MDL material state structure inside the MDL SDK is a representation of the renderer state as defi...
Definition: target_code_types.h:202
tct_float3 normal
The result of state::normal().
Definition: target_code_types.h:209
char const * ro_data_segment
A pointer to a read-only data segment.
Definition: target_code_types.h:263
tct_int object_id
The result of state::object_id().
Definition: target_code_types.h:283
traits::tct_derivable_float3 position
The result of state::position().
Definition: target_code_types.h:217
tct_float4 const * world_to_object
A 4x4 transformation matrix in row-major order transforming from world to object coordinates.
Definition: target_code_types.h:270
tct_float3 const * tangent_v
An array containing the results of state::texture_tangent_v(i).
Definition: target_code_types.h:240
tct_float4 const * object_to_world
A 4x4 transformation matrix in row-major order transforming from object to world coordinates.
Definition: target_code_types.h:277
traits::tct_derivable_float3 const * text_coords
An array containing the results of state::texture_coordinate(i).
Definition: target_code_types.h:226
tct_float animation_time
The result of state::animation_time().
Definition: target_code_types.h:221
tct_float3 geom_normal
The result of state::geometry_normal().
Definition: target_code_types.h:213
tct_float3 const * tangent_u
An array containing the results of state::texture_tangent_u(i).
Definition: target_code_types.h:233
tct_float meters_per_scene_unit
The result of state::meters_per_scene_unit().
Definition: target_code_types.h:288
tct_float4 * text_results
The texture results lookup table.
Definition: target_code_types.h:248
The texture handler structure that is passed to the texturing functions.
Definition: target_code_types.h:707
Texture_handler_vtable const * vtable
In vtable-mode, the vtable field is used to call the texturing functions.
Definition: target_code_types.h:710
The texture handler structure that is passed to the texturing functions with derivative support.
Definition: target_code_types.h:717
Texture_handler_deriv_vtable const * vtable
In vtable-mode, the vtable field is used to call the texturing functions.
Definition: target_code_types.h:720
The runtime for bitmap texture access for the generated target code can optionally be implemented in ...
Definition: target_code_types.h:338
A template struct with derivatives.
Definition: target_code_types.h:87
Helper traits struct to switch between derivative and non-derivative types.
Definition: target_code_types.h:93
Typedefs for types from the math API.