RifFilter.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 RifFilter_h
#define RifFilter_h

/*
 *  RifFilter.h encapsulates the RenderMan Interface
 *  and forms the basis of Ri Plugin Filter Support. (See RifPlugin.h).
 *  Since external developers are expected to subclass
 *  this class definition, it is imperative that new
 *  structure members don't affect previous versions' packing.
 *  We have reserved a block of bytes at the front of the structure
 *  for additional state-maintenance and expect that new Ri
 *  calls will be added at the bottom. k_CurrentVersion should
 *  be incremented whenever "class RifFilter" gets a new member.
 *
 *  Note that RixInterfaces.h contains other useful (public) procedures
 *  for reporting errors, accessing renderer attributes and options,
 *  etc.
 *
 *  NB: New members must ONLY be added at the end of RifFilter struct
 */

#include <stdarg.h>                     // for va_list
#include <string.h>                     // for memset
#include "ri.h"                         // for RtToken, RtVoid, RtPointer, etc
#include "RixInterfaces.h"

struct RifFilter
{
    enum
    {
        k_UnknownVersion = 0,
        /* Version 2 added BrickMap and HierarchicalSubdivisionMesh */
        /* Version 3 added AttributeSave/AttributeRestore (now removed) */
        /* Version 4 added ResourceBegin/ResourceEnd */
        /* Version 5 added System */
        /* Version 6 added Shader, Camera */
        /* Version 7 added ErrorHandler */
        /* Version 8 added:
         *      EditWorldBegin/End,
         *      EditBegin/End,
         *      EditAttributeBegin/End
         * Version 9 added:
         *      PixelSampleImager
         * Version 10 added:
         *      Volume
         *      VPSurface,
         *      VPInterior,
         *      VPAtmosphere
         * Version 11 added:
         *      ObjectBeginV
         *      ObjectInstanceV
         *      Procedural2V
         * Version 12 added:
         *      VolumePixelSamples
         * Version 13 added:
         *      BxdfV
         *      IntegratorV
         *      PatternV
         * Version 14 added:
         *      LightFilterV
         * Version 15 added:
         *      DisplaceV
         *      SampleFilterV
         *      DisplayFilterV
         *      LightV
         */
        k_CurrentVersion = 15
    };

    short Version;     /* the version of the table */
    void* ClientData;  /* a place for the plug-in to hang its hat */
    char Reserved[64]; /* for future use */
    enum DefaultFiltering
    {
        k_Continue,
        k_Terminate
    };
    DefaultFiltering Filtering;
    RifFilter()
    {
        memset((void*)this, 0, sizeof(RifFilter));
        Version   = k_CurrentVersion;
        Filtering = k_Continue;
        // dispatch functions should be initialized to 0L
    }

    RtToken (*Declare)(char const* name, char const* declaration);
    RtVoid (*FrameBegin)(int frame);
    RtVoid (*FrameEnd)();
    RtVoid (*WorldBegin)();
    RtVoid (*WorldEnd)();
    RtVoid (*Clipping)(float hither, float yon);
    RtVoid (*ClippingPlane)(float Nx, float Ny, float Nz, float Px, float Py, float Pz);
    RtVoid (*CropWindow)(float xmin, float xmax, float ymin, float ymax);
    RtVoid (*DepthOfField)(float fstop, float focallength, float focaldistance);
    RtVoid (*Format)(int xres, int yres, float aspect);
    RtVoid (*FrameAspectRatio)(float aspect);
    RtVoid (*ProjectionV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*ScreenWindow)(float left, float right, float top, float bot);
    RtVoid (*Shutter)(float min, float max);
    RtVoid (*DisplayV)(
        char const* name,
        RtToken type,
        RtToken mode,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*Exposure)(float gain, float gamma);
    RtVoid (*ImagerV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*PixelFidelity)(float variation); // OBSOLETE call: see RiPixelVariance
    RtVoid (*PixelFilter)(RtFilterFunc filterFunc, float xwidth, float ywidth);
    RtVoid (*PixelSamples)(float xsamples, float ysamples);
    RtVoid (*PixelVariance)(float variation);
    RtVoid (*Quantize)(RtToken type, int one, int min, int max, float ampl);
    RtVoid (*HiderV)(RtToken type, int, RtToken[], RtPointer[]);
    RtVoid (*OptionV)(RtToken name, int, RtToken[], RtPointer[]);

    RtVoid (*AttributeBegin)();
    RtVoid (*AttributeEnd)();
    RtVoid (*AttributeV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*Color)(float* color);
    RtVoid (*Opacity)(float* color);
    RtVoid (*TextureCoordinates)(
        float s1,
        float t1,
        float s2,
        float t2,
        float s3,
        float t3,
        float s4,
        float t4);
    RtVoid (*Matte)(RtBoolean onoff);
    RtVoid (*ShadingInterpolation)(RtToken type);
    RtVoid (*ShadingRate)(float size);

    RtLightHandle (*AreaLightSourceV)(RtToken name, int, RtToken[], RtPointer[]);
    RtLightHandle (*LightSourceV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*Illuminate)(RtLightHandle light, RtBoolean onoff);
    RtVoid (*AtmosphereV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*DisplacementV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*ExteriorV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*InteriorV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*SurfaceV)(RtToken name, int, RtToken[], RtPointer[]);

    RtVoid (*TransformBegin)();
    RtVoid (*TransformEnd)();
    RtVoid (*Bound)(RtBound bound);
    RtVoid (*Detail)(RtBound bound);
    RtVoid (*DetailRange)(float minv, float lowtran, float uptran, float maxv);
    RtVoid (*RelativeDetail)(float relativedetail);
    RtVoid (*GeometricApproximation)(RtToken type, float value);
    RtVoid (*Orientation)(RtToken orientation);
    RtVoid (*ReverseOrientation)();
    RtVoid (*Sides)(int sides);

    RtVoid (*ConcatTransform)(RtMatrix transform);
    RtVoid (*CoordSysTransform)(RtToken space);
    RtVoid (*CoordinateSystem)(RtToken space);
    RtVoid (*ScopedCoordinateSystem)(RtToken space);

    RtVoid (*Identity)();
    RtVoid (*Perspective)(float fov);
    RtVoid (*Rotate)(float angle, float dx, float dy, float dz);
    RtVoid (*Scale)(float sx, float sy, float sz);
    RtVoid (*Skew)(
        float angle,
        float dx1,
        float dy1,
        float dz1,
        float dx2,
        float dy2,
        float dz2);
    RtVoid (*Transform)(RtMatrix transform);
    RtVoid (*Translate)(float dx, float dy, float dz);

    RtVoid (*Basis)(RtBasis ubasis, int ustep, RtBasis vbasis, int vstep);
    RtVoid (*BlobbyV)(
        int nleaf,
        int ninst,
        int inst[],
        int nflt,
        float flt[],
        int nstr,
        RtConstString str[],
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*ConeV)(
        float height,
        float radius,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*CurvesV)(
        RtToken type,
        int ncurves,
        int nvert[],
        RtToken wrap,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*CylinderV)(
        float rad,
        float zmin,
        float zmax,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*DiskV)(
        float height,
        float radius,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*GeneralPolygonV)(
        int nloops,
        int nverts[],
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*GeometryV)(RtToken type, int, RtToken[], RtPointer[]);
    RtVoid (*HyperboloidV)(
        RtPoint point1,
        RtPoint point2,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*NuPatchV)(
        int nu,
        int uorder,
        float uknot[],
        float umin,
        float umax,
        int nv,
        int vorder,
        float vknot[],
        float vmin,
        float vmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*ParaboloidV)(
        float rmax,
        float zmin,
        float zmax,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*PatchMeshV)(
        RtToken type,
        int nu,
        RtToken uwrap,
        int nv,
        RtToken vwrap,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*PatchV)(RtToken type, int, RtToken[], RtPointer[]);
    RtVoid (*PointsGeneralPolygonsV)(
        int npolys,
        int nloops[],
        int nverts[],
        int verts[],
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*PointsPolygonsV)(
        int npolys,
        int nverts[],
        int verts[],
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*PointsV)(int nverts, int, RtToken[], RtPointer[]);
    RtVoid (*PolygonV)(int nverts, int, RtToken[], RtPointer[]);
    RtVoid (*Procedural)(
        RtPointer data,
        RtBound bound,
        RtProcSubdivFunc sdfunc,
        RtProcFreeFunc freefunc);
    RtVoid (*SphereV)(
        float radius,
        float zmin,
        float zmax,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*SubdivisionMeshV)(
        RtToken mask,
        int nf,
        int nverts[],
        int verts[],
        int nt,
        RtToken tags[],
        int nargs[],
        int intargs[],
        float floatargs[],
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*TorusV)(
        float majrad,
        float minrad,
        float phimin,
        float phimax,
        float tmax,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*TrimCurve)(
        int nloops,
        int ncurves[],
        int order[],
        float knot[],
        float min[],
        float max[],
        int n[],
        float u[],
        float v[],
        float w[]);

    RtVoid (*SolidBegin)(RtToken operation);
    RtVoid (*SolidEnd)();

    RtObjectHandle (*ObjectBegin)();
    RtVoid (*ObjectEnd)();
    RtVoid (*ObjectInstance)(RtObjectHandle handle);

    RtVoid (*MotionBeginV)(int n, float times[]);
    RtVoid (*MotionEnd)();

    RtVoid (*ResourceV)(
        RtToken handle, RtToken type, int, RtToken[], RtPointer[]);

    RtVoid (*MakeCubeFaceEnvironmentV)(
        char const* px,
        char const* nx,
        char const* py,
        char const* ny,
        char const* pz,
        char const* nz,
        char const* tex,
        float fov,
        RtFilterFunc filterFunc,
        float swidth,
        float ywidth,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*MakeLatLongEnvironmentV)(
        char const* pic,
        char const* tex,
        RtFilterFunc filterFunc,
        float swidth,
        float twidth,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*MakeShadowV)(char const* pic, char const* tex, int, RtToken[], RtPointer[]);
    RtVoid (*MakeTextureV)(
        char const* pic,
        char const* tex,
        RtToken swrap,
        RtToken twrap,
        RtFilterFunc filterFunc,
        float swidth,
        float twidth,
        int,
        RtToken[],
        RtPointer[]);

    RtVoid (*_deprecatedFunction1)(); /* ProcDelayedReadArchive */
    RtVoid (*_deprecatedFunction2)(); /* ProcDynamicLoad */
    RtVoid (*_deprecatedFunction3)(); /* ProcRunProgram */

    RtVoid (*VArchiveRecord)(RtToken type, char const* format, va_list vap);
    RtVoid (*ReadArchiveV)(
        RtToken name,
        RtArchiveCallback callback,
        int,
        RtToken[],
        RtPointer[]);

    RtArchiveHandle (*ArchiveBeginV)(RtConstString name, int, RtToken[], RtPointer[]);
    RtVoid (*ArchiveEnd)();

    RtVoid (*IfBeginV)(char const* expr, int, RtToken[], RtPointer[]);
    RtVoid (*ElseIfV)(char const* expr, int, RtToken[], RtPointer[]);
    RtVoid (*Else)();
    RtVoid (*IfEnd)();

    RtVoid (*DisplayChannelV)(RtToken mode, int, RtToken[], RtPointer[]);

    RtVoid (*MakeBrickMapV)(
        int, char const**, char const*, int, RtToken[], RtPointer[]);
    RtVoid (*HierarchicalSubdivisionMeshV)(
        RtToken mask,
        int nf,
        int nverts[],
        int verts[],
        int nt,
        RtToken tags[],
        int nargs[],
        int intargs[],
        float floatargs[],
        RtToken stringargs[],
        int,
        RtToken[],
        RtPointer[]);

    RtVoid (*ResourceBegin)();
    RtVoid (*ResourceEnd)();
    RtVoid (*System)(char const* cmdstring);

    RtVoid (*ShaderV)(
        RtToken name, RtToken handle, int, RtToken[], RtPointer[]);

    RtVoid (*CameraV)(RtToken name, int, RtToken[], RtPointer[]);

    RtVoid (*ErrorHandler)(RtErrorHandler);

    RtVoid (*EditBeginV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*EditEnd)();
    RtVoid (*EditAttributeBegin)(RtToken name);
    RtVoid (*EditAttributeEnd)();
    RtVoid (*EditWorldBeginV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*EditWorldEnd)();

    RtVoid (*PixelSampleImagerV)(RtToken name, int, RtToken[], RtPointer[]);

    /* version 10 */
    RtVoid (*VolumeV)(RtToken type, RtBound, int*, int, RtToken[], RtPointer[]);
    RtVoid (*VPSurfaceV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*VPInteriorV)(RtToken name, int, RtToken[], RtPointer[]);
    RtVoid (*VPAtmosphereV)(RtToken name, int, RtToken[], RtPointer[]);

    /* version 11 */
    RtObjectHandle (*ObjectBeginV)(int, RtToken[], RtPointer[]);
    RtVoid (*ObjectInstanceV)(
        RtObjectHandle handle, int, RtToken[], RtPointer[]);
    RtVoid (*Procedural2V)(
        RtProc2SubdivFunc sfunc,
        RtProc2BoundFunc bfunc,
        int,
        RtToken[],
        RtPointer[]);

    /* version 12 */
    RtVoid (*VolumePixelSamples)(float xsamples, float ysamples);

    /* version 13 */
    RtVoid (*BxdfV)(RtToken name, RtToken handle, int, RtToken[], RtPointer[]);
    RtVoid (*IntegratorV)(
        RtToken name,
        RtToken handle,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*PatternV)(
        RtToken name, RtToken handle, int, RtToken[], RtPointer[]);

    /* version 14 */
    RtVoid (*LightFilterV)(
        RtToken name,
        RtToken handle,
        int,
        RtToken[],
        RtPointer[]);

    RtVoid (*EnableLightFilter)(
        RtLightHandle light,
        RtToken filter,
        RtBoolean onoff);

    /* version 15 */
    RtVoid (*DisplaceV)(
        RtToken name, RtToken handle, int, RtToken[], RtPointer[]);
    RtVoid (*SampleFilterV)(
        RtToken name,
        RtToken handle,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*DisplayFilterV)(
        RtToken name,
        RtToken handle,
        int,
        RtToken[],
        RtPointer[]);
    RtVoid (*LightV)(RtToken name, RtToken handle, int, RtToken[], RtPointer[]);

    /*
    ** New members must ONLY be added at the end (prior to overrunbuffer)
    */

    /*
     * Memory buffer to allow plugins compiled with this header to
     * be opened by later versions of rif (which will use the space
     * for newly added entrypoints).
     */
    char overrunbuffer[64 * 8];
};

#endif