RtxPlugin.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 1986-2019 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 RTXPLUGIN_H
#define RTXPLUGIN_H

#include "prmanapi.h"                   // for PRMANEXPORT
#include "ri.h"                         // for RtPointer

class RixContext; // IWYU pragma: keep

// An RtxPlugin class
class RtxPlugin
{
public:
    RtxPlugin() {}
    virtual ~RtxPlugin() {}

    struct Int2D
    {
        int X;
        int Y;
    };

    struct Tile2D
    {
        Int2D offset;
        Int2D size;
    };

    struct TextureCtx
    {
        int numChannels;

        unsigned int numLayers;

        struct layerSpec
        {
            const char* name;
            unsigned numChannels;
        } * *layers;

        Int2D minRes, maxRes;

        enum WrapMode
        {
            k_Black = 0,
            k_Clamp,
            k_Periodic
        } sWrap,
            tWrap;

        enum DataType
        {
            k_Byte = 0,
            k_Float
        } dataType;

        enum PyramidType
        {
            k_Single = 0,
            k_MIP,
            k_RIP
        } pyramidType;

        bool isLocked;

        unsigned int argc;
        const char** argv;

        void* userData;

        // Version 2 API starts here

        // A plugin can request retry on error
        // a fill may be aborted mid fill request
        // during rerendering (resulting in incorrect fill data)
        // Authors may request such errors during fill are retried
        // during subsequent attempts to fill.
        bool retryOnError;
    };

    virtual int Open(TextureCtx& tCtx) = 0;

    struct FillRequest
    {
        // This is the resolution of the image at a given MIP level
        Int2D imgRes;

        // This is the tile index and tile size
        Tile2D tile;

        // This is a channel selection string. This string can be
        // NULL if channel selection is not made by string.
        const char* channelRefExpr;

        // This is the offset from zero for a given channel selection
        // It is always zero if channelRefExpr is not NULL.
        int channelOffset;

        // This is the number of channels we want to fill
        int numChannels;

        // The data (interleaved) with GetStride() channels
        // that the plugin should write the tile results into
        RtPointer tileData;
    };

    // The plugin should use the fillReq inputs to write to the
    // tileData in the FillRequest. Return nonzero on errors.
    virtual int Fill(TextureCtx& tCtx, FillRequest& fillReq) = 0;

    // The plugin should release all assets at Close()
    virtual int Close(TextureCtx& tCtx) = 0;
};

// A RixContext is provided to an RtxPlugin at
// creation time, so that the plugin may use
// services provided by the renderer.
#define RTXPLUGINCREATE                                    \
    extern "C" const PRMANEXPORT int RtxPluginVersion = 2; \
    extern "C" PRMANEXPORT RtxPlugin* RtxPluginNew(        \
        RixContext* rixCtx, const char* pluginName)
#endif