optix_prime.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 NVIDIA Corporation.  All rights reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property and
 * proprietary rights in and to this software, related documentation and any
 * modifications thereto.  Any use, reproduction, disclosure or distribution of
 * this software and related documentation without an express license agreement
 * from NVIDIA Corporation is strictly prohibited.
 *
 * TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THIS SOFTWARE IS PROVIDED
 * *AS IS* AND NVIDIA AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES, EITHER EXPRESS
 * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL
 * NVIDIA OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR
 * CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR
 * LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
 * INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
 * INABILITY TO USE THIS SOFTWARE, EVEN IF NVIDIA HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES
 */

#ifndef __optix_optix_prime_h__
#define __optix_optix_prime_h__

#define OPTIX_PRIME_VERSION 3090 /* 3.9.0 (major =  OPTIX_PRIME_VERSION/1000,     *
                                  *        minor = (OPTIX_PRIME_VERSION%1000)/10, *
                                  *        micro =  OPTIX_PRIME_VERSION%10        */

#ifndef RTPAPI
#  if defined( _WIN32 )
#    define RTPAPI __declspec(dllimport)
#  else
#    define RTPAPI
#  endif
#endif

#include "optix_prime_declarations.h"

/****************************************
 *
 * PLATFORM-DEPENDENT TYPES
 *
 ****************************************/

#if defined( _WIN64 )
typedef unsigned __int64    RTPsize;
#elif defined( _WIN32 )
typedef unsigned int        RTPsize;
#else
typedef long unsigned int   RTPsize;
#endif

typedef struct RTPcontext_api*    RTPcontext;
typedef struct RTPmodel_api*      RTPmodel;
typedef struct RTPquery_api*      RTPquery;
typedef struct RTPbufferdesc_api* RTPbufferdesc;

/****************************************
 *
 * FORWARD DECLARATIONS
 *
 ****************************************/

typedef struct CUstream_st *cudaStream_t;

#ifdef __cplusplus
extern "C" {
#endif

  /****************************************
   *
   * CONTEXT
   *
   * The context manages the creation of API objects and encapsulates a
   * particular computational backend.
   *
   ****************************************/

  RTPresult RTPAPI rtpContextCreate( RTPcontexttype type, /*out*/ RTPcontext* context );

  RTPresult RTPAPI rtpContextSetCudaDeviceNumbers( RTPcontext  context, unsigned deviceCount, const unsigned* deviceNumbers );


  RTPresult RTPAPI rtpContextSetCpuThreads( RTPcontext context, unsigned numThreads );

  RTPresult RTPAPI rtpContextDestroy( RTPcontext context );

  RTPresult RTPAPI rtpContextGetLastErrorString( RTPcontext context, /*out*/ const char** return_string );



  /****************************************
   *
   * BUFFER DESCRIPTOR
   *
   * A buffer descriptor provides information about a buffer's type, format,
   * and location. It also describes the region of the buffer to use.
   *
   ****************************************/

  RTPresult RTPAPI rtpBufferDescCreate( RTPcontext context, RTPbufferformat format, RTPbuffertype type, void* buffer, /*out*/ RTPbufferdesc* desc );

  RTPresult RTPAPI rtpBufferDescGetContext( RTPbufferdesc desc, /*out*/ RTPcontext* context );

  RTPresult RTPAPI rtpBufferDescSetRange( RTPbufferdesc desc, RTPsize begin, RTPsize end );

  RTPresult RTPAPI rtpBufferDescSetStride( RTPbufferdesc desc, unsigned strideBytes );

  RTPresult RTPAPI rtpBufferDescSetCudaDeviceNumber( RTPbufferdesc desc, unsigned deviceNumber );

  RTPresult RTPAPI rtpBufferDescDestroy( RTPbufferdesc desc );



  /****************************************
   *
   * MODEL
   *
   * A model is a combination of a set of triangles and an acceleration
   * structure
   *
   ****************************************/

  RTPresult RTPAPI rtpModelCreate( RTPcontext context, /*out*/ RTPmodel* model );

  RTPresult RTPAPI rtpModelGetContext( RTPmodel model, RTPcontext* context );

  RTPresult RTPAPI rtpModelSetTriangles( RTPmodel model, RTPbufferdesc indices, RTPbufferdesc vertices );

  RTPresult RTPAPI rtpModelSetInstances( RTPmodel model, RTPbufferdesc instances, RTPbufferdesc transforms );

  RTPresult RTPAPI rtpModelUpdate( RTPmodel model, unsigned hints );

  RTPresult RTPAPI rtpModelFinish( RTPmodel model );

  RTPresult RTPAPI rtpModelGetFinished( RTPmodel model, /*out*/ int* isFinished );

  RTPresult RTPAPI rtpModelCopy( RTPmodel model, RTPmodel srcModel );

  RTPresult RTPAPI rtpModelSetBuilderParameter( RTPmodel model_api, RTPbuilderparam param, RTPsize size, const void* ptr );

  RTPresult RTPAPI rtpModelDestroy( RTPmodel model );



  /****************************************
   *
   *  QUERY
   *
   *  A query encapsulates a ray tracing computation against a model
   *
   ****************************************/

  RTPresult RTPAPI rtpQueryCreate( RTPmodel model, RTPquerytype queryType, /*out*/ RTPquery* query );

  RTPresult RTPAPI rtpQueryGetContext( RTPquery query, /*out*/ RTPcontext* context );

  RTPresult RTPAPI rtpQuerySetRays( RTPquery query, RTPbufferdesc rays );

  RTPresult RTPAPI rtpQuerySetHits( RTPquery query, RTPbufferdesc hits );

  RTPresult RTPAPI rtpQueryExecute( RTPquery query, unsigned hints );

  RTPresult RTPAPI rtpQueryFinish( RTPquery query );

  RTPresult RTPAPI rtpQueryGetFinished( RTPquery query, /*out*/ int* isFinished );

  RTPresult RTPAPI rtpQuerySetCudaStream( RTPquery query, cudaStream_t stream );

  RTPresult RTPAPI rtpQueryDestroy( RTPquery query );

  /****************************************
   *
   * MISC
   *
   ****************************************/
   
  RTPresult RTPAPI rtpHostBufferLock( void* buffer, RTPsize size );

  RTPresult RTPAPI rtpHostBufferUnlock( void* buffer );

  RTPresult RTPAPI rtpGetErrorString( RTPresult errorCode, /*out*/ const char** errorString );

  RTPresult RTPAPI rtpGetVersion( /*out*/ unsigned* version );

  RTPresult RTPAPI rtpGetVersionString( const char** versionString );

#ifdef __cplusplus
}
#endif

#endif /* #ifndef __optix_optix_prime_h__ */