RixDisplayFilter.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 RixDisplayFilter_h
#define RixDisplayFilter_h

#include "RixIntegrator.h"              // for RixChannelId
#include "RixInterfaces.h"              // for RixContext
#include "RixShading.h"                 // for RixShadingPlugin, etc
#include "prmanapi.h"                   // for PRMANEXPORT
#include "RiTypesHelper.h"              // for RtColorRGB

class RixDisplayFilterContext;


class RixDisplayFilter : public RixShadingPlugin
{
public:
    int GetInterface() const override { return k_RixDisplayFilter; }


    virtual void Filter(
        RixDisplayFilterContext& fCtx,
        void* instanceData) = 0;

protected:
    RixDisplayFilter() : RixShadingPlugin(k_RixShadingVersion) {}
    ~RixDisplayFilter() override {}
};

// clang-format off
#define RIX_DISPLAYFILTERCREATE \
    extern "C" PRMANEXPORT RixDisplayFilter* CreateRixDisplayFilter(RtConstString hint)

#define RIX_DISPLAYFILTERDESTROY \
    extern "C" PRMANEXPORT void DestroyRixDisplayFilter(RixDisplayFilter* filter)
// clang-format on

class RixDisplayFilterContext : public RixContext
{
public:

    int xmin;
    int xmax;
    int ymin;
    int ymax;


    virtual bool Read(RixChannelId id, int x, int y, RtColorRGB &value) const = 0;
    virtual bool Read(RixChannelId id, int x, int y, float &value) const = 0;
    virtual bool Read(RixChannelId id, int x, int y, int &value) const = 0;

    virtual bool Write(RixChannelId id, int x, int y, RtColorRGB value) = 0;
    virtual bool Write(RixChannelId id, int x, int y, float value) = 0;
    virtual bool Write(RixChannelId id, int x, int y, int value) = 0;


    virtual bool ReadRegion(RixChannelId id,
                            int regionMinX, int regionMaxX,
                            int regionMinY, int regionMaxY,
                            RtColorRGB *values) const = 0;
    virtual bool ReadRegion(RixChannelId id,
                            int regionMinX, int regionMaxX,
                            int regionMinY, int regionMaxY,
                            float *values) const = 0;

    virtual bool IsEnabled(
        void const* instance,
        void** instanceData) const = 0;

protected:
    RixDisplayFilterContext() : RixContext() {}
    ~RixDisplayFilterContext() override {}
};

#endif