NVIDIA OptiX 7.1 API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Modules

Functions

OptixResult optixModuleCreateFromPTX (OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const char *PTX, size_t PTXsize, char *logString, size_t *logStringSize, OptixModule *module)
 
OptixResult optixModuleDestroy (OptixModule module)
 
OptixResult optixBuiltinISModuleGet (OptixDeviceContext context, const OptixModuleCompileOptions *moduleCompileOptions, const OptixPipelineCompileOptions *pipelineCompileOptions, const OptixBuiltinISOptions *builtinISOptions, OptixModule *builtinModule)
 

Detailed Description

Function Documentation

OptixResult optixBuiltinISModuleGet ( OptixDeviceContext  context,
const OptixModuleCompileOptions moduleCompileOptions,
const OptixPipelineCompileOptions pipelineCompileOptions,
const OptixBuiltinISOptions builtinISOptions,
OptixModule builtinModule 
)

Returns a module containing the intersection program for the built-in primitive type specified by the builtinISOptions. This module must be used as the moduleIS for the OptixProgramGroupHitgroup in any SBT record for that primitive type. (The entryFunctionNameIS should be null.)

OptixResult optixModuleCreateFromPTX ( OptixDeviceContext  context,
const OptixModuleCompileOptions moduleCompileOptions,
const OptixPipelineCompileOptions pipelineCompileOptions,
const char *  PTX,
size_t  PTXsize,
char *  logString,
size_t *  logStringSize,
OptixModule module 
)

logString is an optional buffer that contains compiler feedback and errors. This information is also passed to the context logger (if enabled), however it may be difficult to correlate output to the logger to specific API invocations when using multiple threads. The output to logString will only contain feedback for this specific invocation of this API call.

logStringSize as input should be a pointer to the number of bytes backing logString. Upon return it contains the length of the log message (including the null terminator) which may be greater than the input value. In this case, the log message will be truncated to fit into logString.

If logString or logStringSize are NULL, no output is written to logString. If logStringSize points to a value that is zero, no output is written. This does not affect output to the context logger if enabled.

Parameters
[in]context
[in]moduleCompileOptions
[in]pipelineCompileOptionsAll modules in a pipeline need to use the same values for the pipeline compile options.
[in]PTXPointer to the PTX input string.
[in]PTXsizeParsing proceeds up to PTXsize characters, or the first NUL byte, whichever occurs first.
[out]logStringInformation will be written to this string. If logStringSize > 0 logString will be null terminated.
[in,out]logStringSize
[out]module
Returns
OPTIX_ERROR_INVALID_VALUE - context is 0, moduleCompileOptions is 0, pipelineCompileOptions is 0, PTX is 0, module is 0.
OptixResult optixModuleDestroy ( OptixModule  module)

Call for OptixModule objects created with optixModuleCreateFromPTX and optixModuleDeserialize.

Modules must not be destroyed while they are still used by any program group.

Thread safety: A module must not be destroyed while it is still in use by concurrent API calls in other threads.