prmanapi.h File Reference

#include <stdint.h>

Go to the source code of this file.

Macros
#define	_PRMANAPI_VERSION_   23
#define	_PRMANAPI_RELEASE_   0
#define	_PRMANAPI_VERSION_MAJOR_   23
#define	_PRMANAPI_VERSION_MINOR_   0
#define	_PRMANAPI_VERSION_BUILD_   0
#define	PRMANIMPORT
#define	PRMANEXPORT   __attribute__ ((visibility("default")))
#define	RSLEXPORT   __attribute__ ((visibility("default")))
#define	PRMAN_INLINE   inline
#define	PRMAN_NOINLINE   __attribute__((noinline))
#define	PRMAN_ALIGNED(...)   __attribute__((aligned(__VA_ARGS__)))
#define	PRMAN_ALIGNED_16   PRMAN_ALIGNED(16)
#define	PRMAN_ALIGNED_64   PRMAN_ALIGNED(64)
#define	PRMAN_ALIGNED_4096   PRMAN_ALIGNED(4096)
#define	PRMAN_INLINE_NONDEBUG   PRMAN_NOINLINE
#define	PRMANAPI   PRMANIMPORT
#define	PRMANSDKAPI   PRMANAPI
#define	PIXAR_ARGUSED(x)   (void) x

Typedefs
typedef int64_t	RtInt64
typedef uint64_t	RtUInt64

Functions
PRMANAPI int	PRManBegin (int argc, char *argv[])
PRMANAPI int	PRManGo ()
PRMANAPI int	PRManEnd ()
	PRManEnd Shuts down and cleans up and unloads the RenderMan library. More...

Macro Definition Documentation

_PRMANAPI_RELEASE_

#define _PRMANAPI_RELEASE_   0

Definition at line 54 of file prmanapi.h.

_PRMANAPI_VERSION_

#define _PRMANAPI_VERSION_   23

Definition at line 53 of file prmanapi.h.

_PRMANAPI_VERSION_BUILD_

#define _PRMANAPI_VERSION_BUILD_   0

Definition at line 65 of file prmanapi.h.

_PRMANAPI_VERSION_MAJOR_

#define _PRMANAPI_VERSION_MAJOR_   23

Definition at line 63 of file prmanapi.h.

_PRMANAPI_VERSION_MINOR_

#define _PRMANAPI_VERSION_MINOR_   0

Definition at line 64 of file prmanapi.h.

PIXAR_ARGUSED

#define PIXAR_ARGUSED

(

x

)

(void) x

Definition at line 171 of file prmanapi.h.

PRMAN_ALIGNED

#define PRMAN_ALIGNED

(

...

)

__attribute__((aligned(__VA_ARGS__)))

Definition at line 89 of file prmanapi.h.

PRMAN_ALIGNED_16

#define PRMAN_ALIGNED_16   PRMAN_ALIGNED(16)

Definition at line 96 of file prmanapi.h.

PRMAN_ALIGNED_4096

#define PRMAN_ALIGNED_4096   PRMAN_ALIGNED(4096)

Definition at line 98 of file prmanapi.h.

PRMAN_ALIGNED_64

#define PRMAN_ALIGNED_64   PRMAN_ALIGNED(64)

Definition at line 97 of file prmanapi.h.

PRMAN_INLINE

#define PRMAN_INLINE   inline

Definition at line 86 of file prmanapi.h.

PRMAN_INLINE_NONDEBUG

#define PRMAN_INLINE_NONDEBUG   PRMAN_NOINLINE

Definition at line 101 of file prmanapi.h.

PRMAN_NOINLINE

#define PRMAN_NOINLINE   __attribute__((noinline))

Definition at line 88 of file prmanapi.h.

PRMANAPI

#define PRMANAPI   PRMANIMPORT

Definition at line 111 of file prmanapi.h.

PRMANEXPORT

#define PRMANEXPORT   __attribute__ ((visibility("default")))

Definition at line 81 of file prmanapi.h.

PRMANIMPORT

#define PRMANIMPORT

Definition at line 80 of file prmanapi.h.

PRMANSDKAPI

#define PRMANSDKAPI   PRMANAPI

Definition at line 125 of file prmanapi.h.

RSLEXPORT

#define RSLEXPORT   __attribute__ ((visibility("default")))

Definition at line 82 of file prmanapi.h.

Typedef Documentation

RtInt64

typedef int64_t RtInt64

Definition at line 130 of file prmanapi.h.

RtUInt64

typedef uint64_t RtUInt64

Definition at line 131 of file prmanapi.h.

Function Documentation

PRManBegin()

PRMANAPI int PRManBegin	(	int	argc,
		char *	argv[]
	)

PRManBegin Initializes the RenderMan library and setups up the devkit. argc: the count of items in argv NOTE: argv[0] has special meaning. If argv[0] is "prman", the API will be setup in the same way as the prman command-line program; installing the default Xcpt handler, signal handlers, and resource initialization.

If argv[0] is "" the API will be setup in wrapper mode and none of the standard command line initialization will be performed, allowing a wrapper to create its own.

PRManEnd()

PRMANAPI int PRManEnd

(

)

PRManEnd Shuts down and cleans up and unloads the RenderMan library.

PRManGo()

PRMANAPI int PRManGo

(

)

PRManGo Initiates the rendering component of the devkit, calls to start/stop rendering (e.g.: RiBegin/RiEnd) can be made once the devkit has been initiated.