prmanapi.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 2020 Pixar. All rights reserved.
#
# The information in this file (the "Software") is provided for the exclusive
# use of the software licensees of Pixar ("Licensees").  Licensees have the
# right to incorporate the Software into other products for use by other
# authorized software licensees of Pixar, without fee. Except as expressly
# permitted herein, the Software may not be disclosed to third parties, copied
# or duplicated in any form, in whole or in part, without the prior written
# permission of Pixar.
#
# The copyright notices in the Software and this entire statement, including the
# above license grant, this restriction and the following disclaimer, must be
# included in all copies of the Software, in whole or in part, and all permitted
# derivative works of the Software, unless such copies or derivative works are
# solely in the form of machine-executable object code generated by a source
# language processor.
#
# PIXAR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL PIXAR BE
# LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  IN NO CASE WILL
# PIXAR'S TOTAL LIABILITY FOR ALL DAMAGES ARISING OUT OF OR IN CONNECTION WITH
# THE USE OR PERFORMANCE OF THIS SOFTWARE EXCEED $50.
#
# Pixar
# 1200 Park Ave
# Emeryville CA 94608
#
# ------------------------------------------------------------------------------
*/

#ifndef PRMANAPI_H
#define PRMANAPI_H

/* Pixar's PhotoRealistic RenderMan API header file */

/* This header file is used to create decoration for function
 * definitions that will be used by external consumers of the
 * interface. The interface has to change "gender" based on the
 * construction of the interface or the consumption of the interface.
 * This can then be used by all public header files
 */

/**********************************/
/* API VERSION MACROS             */
/**********************************/
#define _PRMANAPI_VERSION_  24
#define _PRMANAPI_RELEASE_  0

/* Generally RenderMan plugin APIs are guaranteed to be stable
 * for a given MAJOR version.  Usually they are much more stable
 * than that as our RixInterface layer offers certain forward
 * compatibility guarantees.  In the course of the development
 * of a new API, this guarantee is relaxed and it may be
 * useful to conditionally compile based on the BUILD.
 */
#define _PRMANAPI_VERSION_MAJOR_  24
#define _PRMANAPI_VERSION_MINOR_  0
#define _PRMANAPI_VERSION_BUILD_  0

/* Macros for symbol concatenation */
#define PRMAN_CAT(a, b) a ## b
#define PRMAN_XCAT(a, b) PRMAN_CAT(a, b)

/* Define versioned C++ rman namespace */
#ifdef __cplusplus
#define RMAN_NAMESPACE rman::v24_0
#define RMAN_NAMESPACE_OPEN_SCOPE namespace rman { inline namespace v24_0 {
#define RMAN_NAMESPACE_CLOSE_SCOPE } }

/* Define the public name for the namespace as the versioned one. */
namespace rman { inline namespace v24_0 { } }
#endif

/* First define IMPORT and EXPORT */
#ifdef _MSC_VER
#    define PRMANIMPORT __declspec(dllimport)
#    define PRMANEXPORT __declspec(dllexport)
#    define RSLEXPORT   __declspec(dllexport)  /* for backwards compatability */
#  ifdef NDEBUG
#    define PRMAN_INLINE __forceinline
#  else
#    define PRMAN_INLINE inline
#  endif
#    define PRMAN_NOINLINE __declspec(noinline)
#    define PRMAN_ALIGNED(...) __declspec(align(__VA_ARGS__))
#else
#    define PRMANIMPORT
#    define PRMANEXPORT __attribute__ ((visibility("default")))
#    define RSLEXPORT   __attribute__ ((visibility("default")))
#  ifdef NDEBUG
#    define PRMAN_INLINE inline __attribute__((always_inline))
#  else
#    define PRMAN_INLINE inline
#  endif
#    define PRMAN_NOINLINE __attribute__((noinline))
#    define PRMAN_ALIGNED(...) __attribute__((aligned(__VA_ARGS__)))
#endif

/* The use of PRMAN_ALIGNED(...) in the definition of structs  */
/* confuses some IDEs, impairing symbols search. The following */
/* wrapper macros are to avoid the problem for commonly used   */
/* alignment sizes. */
#define PRMAN_ALIGNED_16   PRMAN_ALIGNED(16)
#define PRMAN_ALIGNED_64   PRMAN_ALIGNED(64)
#define PRMAN_ALIGNED_4096 PRMAN_ALIGNED(4096)

#ifndef NDEBUG
#define PRMAN_INLINE_NONDEBUG  PRMAN_NOINLINE
#else
#define PRMAN_INLINE_NONDEBUG  PRMAN_INLINE
#endif

/* Now switch if we are BUILDING the API or CONSUMING the API */
/* By default consumers of the API need not #define anything  */
#ifdef PRMANBUILDINGAPI 
#    define PRMANAPI PRMANEXPORT
#else
#    define PRMANAPI PRMANIMPORT
#endif

/* A 64-bit signed/unsigned integer on all platforms */
#include <stdint.h>
typedef int64_t RtInt64;
typedef uint64_t RtUInt64;

/* Here is an interface for c callers..., might be used by
 * clients of libprman.so. These need to be public API
 * entry points, since they are called from clients
 * of the dynamic runtime.
 */
#ifndef __cplusplus
    //   argv: contains arguments that are utilized by prman.  
    //         e.g.: -t:2 -progress -capture
    PRMANAPI int PRManBegin(int argc, char *argv[]);

    PRMANAPI int PRManGo();

    PRMANAPI int PRManEnd();
#else
    extern "C" PRMANAPI int PRManBegin(int argc, char *argv[]);
    extern "C" PRMANAPI int PRManGo();
    extern "C" PRMANAPI int PRManEnd();
#endif

/* A macro for silencing compiler warnings about unused parameters */
#ifndef PIXAR_ARGUSED
#    define PIXAR_ARGUSED(x) (void) x
#endif

#endif /* PRMANAPI */