optix_host.h

Go to the documentation of this file.

/* 
* SPDX-FileCopyrightText: Copyright (c) 2010 - 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 
* SPDX-License-Identifier: LicenseRef-NvidiaProprietary 
* 
* NVIDIA CORPORATION, its affiliates and licensors retain all intellectual 
* property and proprietary rights in and to this material, related 
* documentation and any modifications thereto. Any use, reproduction
* disclosure or distribution of this material and related documentation 
* without an express license agreement from NVIDIA CORPORATION or 
* its affiliates is strictly prohibited. 
*/
 
#ifndef OPTIX_OPTIX_HOST_H
#define OPTIX_OPTIX_HOST_H
 
#ifndef OPTIXAPI
# ifdef OPTIX_ENABLE_SDK_MIXING
#   define OPTIXAPI static
# else  // OPTIX_ENABLE_SDK_MIXING
#   ifdef __cplusplus
#     define OPTIXAPI extern "C"
#   else  // __cplusplus
#     define OPTIXAPI
#   endif  // __cplusplus
# endif  // OPTIX_ENABLE_SDK_MIXING
#endif  // OPTIXAPI
 
#include "optix_types.h"
#if !defined( OPTIX_DONT_INCLUDE_CUDA )
// If OPTIX_DONT_INCLUDE_CUDA is defined, cuda driver types must be defined through other
// means before including optix headers.
#include <cuda.h>
#endif
 
#ifdef NV_MODULE_OPTIX
// This is a mechanism to include <g_nvconfig.h> in driver builds only and translate any nvconfig macro to a custom OPTIX-specific macro, that can also be used in SDK builds/installs
#include <exp/misc/optix_nvconfig_translate.h>  // includes <g_nvconfig.h>
#endif  // NV_MODULE_OPTIX
 
 
 
 
 
OPTIXAPI const char* optixGetErrorName( OptixResult result );
 
OPTIXAPI const char* optixGetErrorString( OptixResult result );
 
 
 
 
OPTIXAPI OptixResult optixDeviceContextCreate( CUcontext fromContext, const OptixDeviceContextOptions* options, OptixDeviceContext* context );
 
OPTIXAPI OptixResult optixDeviceContextDestroy( OptixDeviceContext context );
 
OPTIXAPI OptixResult optixDeviceContextGetProperty( OptixDeviceContext context, OptixDeviceProperty property, void* value, size_t sizeInBytes );
 
OPTIXAPI OptixResult optixDeviceContextSetLogCallback( OptixDeviceContext context,
                                                       OptixLogCallback   callbackFunction,
                                                       void*              callbackData,
                                                       unsigned int       callbackLevel );
 
OPTIXAPI OptixResult optixDeviceContextSetCacheEnabled( OptixDeviceContext context, int enabled );
 
OPTIXAPI OptixResult optixDeviceContextSetCacheLocation( OptixDeviceContext context, const char* location );
 
OPTIXAPI OptixResult optixDeviceContextSetCacheDatabaseSizes( OptixDeviceContext context, size_t lowWaterMark, size_t highWaterMark );
 
OPTIXAPI OptixResult optixDeviceContextGetCacheEnabled( OptixDeviceContext context, int* enabled );
OPTIXAPI OptixResult optixDeviceContextGetCacheLocation( OptixDeviceContext context, char* location, size_t locationSize );
 
OPTIXAPI OptixResult optixDeviceContextGetCacheDatabaseSizes( OptixDeviceContext context, size_t* lowWaterMark, size_t* highWaterMark );
 
 
 
 
OPTIXAPI OptixResult optixPipelineCreate( OptixDeviceContext                 context,
                                          const OptixPipelineCompileOptions* pipelineCompileOptions,
                                          const OptixPipelineLinkOptions*    pipelineLinkOptions,
                                          const OptixProgramGroup*           programGroups,
                                          unsigned int                       numProgramGroups,
                                          char*                              logString,
                                          size_t*                            logStringSize,
                                          OptixPipeline*                     pipeline );
 
OPTIXAPI OptixResult optixPipelineDestroy( OptixPipeline pipeline );
 
OPTIXAPI OptixResult optixPipelineSetStackSize( OptixPipeline pipeline,
                                                unsigned int  directCallableStackSizeFromTraversal,
                                                unsigned int  directCallableStackSizeFromState,
                                                unsigned int  continuationStackSize,
                                                unsigned int  maxTraversableGraphDepth );
 
 
 
 
OPTIXAPI OptixResult optixModuleCreate( OptixDeviceContext                 context,
                                        const OptixModuleCompileOptions*   moduleCompileOptions,
                                        const OptixPipelineCompileOptions* pipelineCompileOptions,
                                        const char*                        input,
                                        size_t                             inputSize,
                                        char*                              logString,
                                        size_t*                            logStringSize,
                                        OptixModule*                       module );
 
OPTIXAPI OptixResult optixModuleCreateWithTasks( OptixDeviceContext                 context,
                                                 const OptixModuleCompileOptions*   moduleCompileOptions,
                                                 const OptixPipelineCompileOptions* pipelineCompileOptions,
                                                 const char*                        input,
                                                 size_t                             inputSize,
                                                 char*                              logString,
                                                 size_t*                            logStringSize,
                                                 OptixModule*                       module,
                                                 OptixTask*                         firstTask );
 
OPTIXAPI OptixResult optixModuleGetCompilationState( OptixModule module, OptixModuleCompileState* state );
 
OPTIXAPI OptixResult optixModuleDestroy( OptixModule module );
 
OPTIXAPI OptixResult optixBuiltinISModuleGet( OptixDeviceContext                 context,
                                              const OptixModuleCompileOptions*   moduleCompileOptions,
                                              const OptixPipelineCompileOptions* pipelineCompileOptions,
                                              const OptixBuiltinISOptions*       builtinISOptions,
                                              OptixModule*                       builtinModule );
 
 
 
 
OPTIXAPI OptixResult optixTaskExecute( OptixTask     task,
                                       OptixTask*    additionalTasks,
                                       unsigned int  maxNumAdditionalTasks,
                                       unsigned int* numAdditionalTasksCreated );
 
 
 
 
OPTIXAPI OptixResult optixProgramGroupGetStackSize( OptixProgramGroup programGroup, OptixStackSizes* stackSizes, OptixPipeline pipeline );
 
OPTIXAPI OptixResult optixProgramGroupCreate( OptixDeviceContext              context,
                                              const OptixProgramGroupDesc*    programDescriptions,
                                              unsigned int                    numProgramGroups,
                                              const OptixProgramGroupOptions* options,
                                              char*                           logString,
                                              size_t*                         logStringSize,
                                              OptixProgramGroup*              programGroups );
 
OPTIXAPI OptixResult optixProgramGroupDestroy( OptixProgramGroup programGroup );
 
 
 
 
OPTIXAPI OptixResult optixLaunch( OptixPipeline                  pipeline,
                                  CUstream                       stream,
                                  CUdeviceptr                    pipelineParams,
                                  size_t                         pipelineParamsSize,
                                  const OptixShaderBindingTable* sbt,
                                  unsigned int                   width,
                                  unsigned int                   height,
                                  unsigned int                   depth );
 
OPTIXAPI OptixResult optixSbtRecordPackHeader( OptixProgramGroup programGroup, void* sbtRecordHeaderHostPointer );
 
 
 
 
OPTIXAPI OptixResult optixAccelComputeMemoryUsage( OptixDeviceContext            context,
                                                   const OptixAccelBuildOptions* accelOptions,
                                                   const OptixBuildInput*        buildInputs,
                                                   unsigned int                  numBuildInputs,
                                                   OptixAccelBufferSizes*        bufferSizes );
 
OPTIXAPI OptixResult optixAccelBuild( OptixDeviceContext            context,
                                      CUstream                      stream,
                                      const OptixAccelBuildOptions* accelOptions,
                                      const OptixBuildInput*        buildInputs,
                                      unsigned int                  numBuildInputs,
                                      CUdeviceptr                   tempBuffer,
                                      size_t                        tempBufferSizeInBytes,
                                      CUdeviceptr                   outputBuffer,
                                      size_t                        outputBufferSizeInBytes,
                                      OptixTraversableHandle*       outputHandle,
                                      const OptixAccelEmitDesc*     emittedProperties,
                                      unsigned int                  numEmittedProperties );
 
OPTIXAPI OptixResult optixAccelGetRelocationInfo( OptixDeviceContext context, OptixTraversableHandle handle, OptixRelocationInfo* info );
 
OPTIXAPI OptixResult optixCheckRelocationCompatibility( OptixDeviceContext context, const OptixRelocationInfo* info, int* compatible );
 
OPTIXAPI OptixResult optixAccelRelocate( OptixDeviceContext         context,
                                         CUstream                   stream,
                                         const OptixRelocationInfo* info,
                                         const OptixRelocateInput*  relocateInputs,
                                         size_t                     numRelocateInputs,
                                         CUdeviceptr                targetAccel,
                                         size_t                     targetAccelSizeInBytes,
                                         OptixTraversableHandle*    targetHandle );
 
OPTIXAPI OptixResult optixAccelCompact( OptixDeviceContext      context,
                                        CUstream                stream,
                                        OptixTraversableHandle  inputHandle,
                                        CUdeviceptr             outputBuffer,
                                        size_t                  outputBufferSizeInBytes,
                                        OptixTraversableHandle* outputHandle );
 
OPTIXAPI OptixResult optixAccelEmitProperty( OptixDeviceContext        context,
                                             CUstream                  stream,
                                             OptixTraversableHandle    handle,
                                             const OptixAccelEmitDesc* emittedProperty );
 
OPTIXAPI OptixResult optixConvertPointerToTraversableHandle( OptixDeviceContext      onDevice,
                                                             CUdeviceptr             pointer,
                                                             OptixTraversableType    traversableType,
                                                             OptixTraversableHandle* traversableHandle );
 
 
OPTIXAPI OptixResult optixOpacityMicromapArrayComputeMemoryUsage( OptixDeviceContext                         context,
                                                                  const OptixOpacityMicromapArrayBuildInput* buildInput,
                                                                  OptixMicromapBufferSizes* bufferSizes );
 
OPTIXAPI OptixResult optixOpacityMicromapArrayBuild( OptixDeviceContext                         context,
                                                     CUstream                                   stream,
                                                     const OptixOpacityMicromapArrayBuildInput* buildInput,
                                                     const OptixMicromapBuffers*                buffers );
 
OPTIXAPI OptixResult optixOpacityMicromapArrayGetRelocationInfo( OptixDeviceContext   context,
                                                                 CUdeviceptr          opacityMicromapArray,
                                                                 OptixRelocationInfo* info );
 
OPTIXAPI OptixResult optixOpacityMicromapArrayRelocate( OptixDeviceContext         context,
                                                        CUstream                   stream,
                                                        const OptixRelocationInfo* info,
                                                        CUdeviceptr                targetOpacityMicromapArray,
                                                        size_t targetOpacityMicromapArraySizeInBytes );
 
OPTIXAPI OptixResult optixDisplacementMicromapArrayComputeMemoryUsage( OptixDeviceContext context,
                                                                       const OptixDisplacementMicromapArrayBuildInput* buildInput,
                                                                       OptixMicromapBufferSizes* bufferSizes );
 
OPTIXAPI OptixResult optixDisplacementMicromapArrayBuild( OptixDeviceContext                              context,
                                                          CUstream                                        stream,
                                                          const OptixDisplacementMicromapArrayBuildInput* buildInput,
                                                          const OptixMicromapBuffers*                     buffers );
 
 
 
 
 
OPTIXAPI OptixResult optixDenoiserCreate( OptixDeviceContext          context,
                                          OptixDenoiserModelKind      modelKind,
                                          const OptixDenoiserOptions* options,
                                          OptixDenoiser*              denoiser );
 
OPTIXAPI OptixResult optixDenoiserCreateWithUserModel( OptixDeviceContext context,
                                                       const void*        userData,
                                                       size_t             userDataSizeInBytes,
                                                       OptixDenoiser*     denoiser );
 
OPTIXAPI OptixResult optixDenoiserDestroy( OptixDenoiser denoiser );
 
OPTIXAPI OptixResult optixDenoiserComputeMemoryResources( const OptixDenoiser denoiser,
                                                          unsigned int        outputWidth,
                                                          unsigned int        outputHeight,
                                                          OptixDenoiserSizes* returnSizes );
 
OPTIXAPI OptixResult optixDenoiserSetup( OptixDenoiser denoiser,
                                         CUstream      stream,
                                         unsigned int  inputWidth,
                                         unsigned int  inputHeight,
                                         CUdeviceptr   denoiserState,
                                         size_t        denoiserStateSizeInBytes,
                                         CUdeviceptr   scratch,
                                         size_t        scratchSizeInBytes );
 
OPTIXAPI OptixResult optixDenoiserInvoke( OptixDenoiser                  denoiser,
                                          CUstream                       stream,
                                          const OptixDenoiserParams*     params,
                                          CUdeviceptr                    denoiserState,
                                          size_t                         denoiserStateSizeInBytes,
                                          const OptixDenoiserGuideLayer* guideLayer,
                                          const OptixDenoiserLayer*      layers,
                                          unsigned int                   numLayers,
                                          unsigned int                   inputOffsetX,
                                          unsigned int                   inputOffsetY,
                                          CUdeviceptr                    scratch,
                                          size_t                         scratchSizeInBytes );
 
OPTIXAPI OptixResult optixDenoiserComputeIntensity( OptixDenoiser       denoiser,
                                                    CUstream            stream,
                                                    const OptixImage2D* inputImage,
                                                    CUdeviceptr         outputIntensity,
                                                    CUdeviceptr         scratch,
                                                    size_t              scratchSizeInBytes );
 
OPTIXAPI OptixResult optixDenoiserComputeAverageColor( OptixDenoiser       denoiser,
                                                       CUstream            stream,
                                                       const OptixImage2D* inputImage,
                                                       CUdeviceptr         outputAverageColor,
                                                       CUdeviceptr         scratch,
                                                       size_t              scratchSizeInBytes );
 
 
#include "optix_function_table.h"
 
#endif  // OPTIX_OPTIX_HOST_H