RixShaderInfo.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 _RixShaderQuery_h
#define _RixShaderQuery_h

#include "RixInterfaces.h"

class RixShaderParameter {
    
public:
    
    enum RixShaderParameterType
    {
        k_Int,
        k_Float,
        k_String,
        k_Color,
        k_Point,
        k_Normal,
        k_Vector,
        k_Matrix,
        k_Unknown
    };
    
    enum RixShaderBaseType {
        k_UNKNOWN, k_NONE,
        k_UCHAR, k_UINT8 = k_UCHAR, k_CHAR, k_INT8 = k_CHAR,
        k_USHORT, k_UINT16 = k_USHORT, k_SHORT, k_INT16 = k_SHORT,
        k_UINT, k_UINT32 = k_UINT, k_INT, k_INT32 = k_INT,
        k_ULONGLONG, k_UINT64 = k_ULONGLONG, k_LONGLONG, k_INT64 = k_LONGLONG,
        k_HALF, k_FLOAT, k_DOUBLE, k_STRING, k_PTR, k_LASTBASE
    };

    enum RixShaderAggregateType
    {
        k_Scalar,
        k_Vec2,
        k_Vec3,
        k_Vec4,
        k_Matrix33,
        k_Matrix44
    };

    enum RixShaderVectorSemantics
    {
        k_VSColor,
        k_VSPoint,
        k_VSVector,
        k_VSNormal
    };

public:
    
    virtual ~RixShaderParameter() {};
    
    virtual const char*
    Name(void) const = 0;
    
    virtual const char*
    StructName(void) const = 0;
    
    virtual RixShaderParameterType
    Type(void) const = 0;

    virtual RixShaderBaseType
    BaseType(void) const = 0;

    virtual RixShaderAggregateType
    AggregateType(void) const = 0;

    virtual RixShaderVectorSemantics
    VectorSemantics(void) const = 0;

    virtual bool
    IsOutput(void) const = 0;
    
    virtual bool
    IsStruct(void) const = 0;
    
    virtual bool
    IsArray(void) const = 0;

    virtual int
    ArrayLength(void) const = 0;
    
    virtual int
    DefaultSize(void) const = 0;

    virtual const int*
    DefaultI(void) const = 0;

    virtual const float*
    DefaultF(void) const = 0;

    virtual const char**
    DefaultS(void) const = 0;
    
    virtual int
    MetaDataSize(void) const = 0;
    
    virtual const RixShaderParameter* const*
    MetaData(void) const = 0;
   
};

class RixShaderQuery {
    
public:
    
    virtual ~RixShaderQuery(void) {};

    virtual bool
    Open(const char* name, const char* searchPath) = 0;

    virtual const char*
    LastError(void) = 0;

    virtual int
    ParameterCount(void) const = 0;

    virtual const RixShaderParameter* const*
    Parameters(void) const = 0;
    
    virtual int
    MetaDataCount(void) const = 0;

    virtual const RixShaderParameter* const*
    MetaData(void) const = 0;

    virtual const char*
    ShaderName(void) const = 0;
    
    virtual const char*
    ShaderType(void) const = 0;
};

class RixShaderInfo  : public RixInterface {
public:
    
    virtual RixShaderQuery*
    CreateQuery(void) = 0;
    
protected:
    
    RixShaderInfo() : RixInterface(1) {}
    
};
#endif