Appearance.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_APPEARANCE_H
#define RAMSES_APPEARANCE_H
 
#include "ramses-client-api/SceneObject.h"
#include "ramses-client-api/AppearanceEnums.h"
 
namespace ramses
{
    class SceneImpl;
    class UniformInput;
    class DataObject;
    class TextureSampler;
    class TextureSamplerMS;
    class TextureSamplerExternal;
    class Effect;
 
    class RAMSES_API Appearance : public SceneObject
    {
    public:
        status_t setBlendingFactors(EBlendFactor srcColor, EBlendFactor destColor, EBlendFactor srcAlpha, EBlendFactor destAlpha);
 
        status_t getBlendingFactors(EBlendFactor& srcColor, EBlendFactor& destColor, EBlendFactor& srcAlpha, EBlendFactor& destAlpha) const;
 
        status_t setBlendingOperations(EBlendOperation operationColor, EBlendOperation operationAlpha);
 
        status_t getBlendingOperations(EBlendOperation& operationColor, EBlendOperation& operationAlpha) const;
 
        status_t setBlendingColor(float red, float green, float blue, float alpha);
 
        status_t getBlendingColor(float& red, float& green, float& blue, float& alpha) const;
 
        status_t setDepthWrite(EDepthWrite mode);
 
        status_t getDepthWriteMode(EDepthWrite& mode) const;
 
        status_t setDepthFunction(EDepthFunc func);
 
        status_t getDepthFunction(EDepthFunc& func) const;
 
        status_t setScissorTest(EScissorTest state, int16_t x, int16_t y, uint16_t width, uint16_t height);
 
        status_t getScissorTestState(EScissorTest& state) const;
 
        status_t getScissorRegion(int16_t& x, int16_t& y, uint16_t& width, uint16_t& height) const;
 
        status_t setStencilFunction(EStencilFunc func, uint8_t ref, uint8_t mask);
 
        status_t getStencilFunction(EStencilFunc& func, uint8_t& ref, uint8_t& mask) const;
 
        status_t setStencilOperation(EStencilOperation sfail, EStencilOperation dpfail, EStencilOperation dppass);
 
        status_t getStencilOperation(EStencilOperation& sfail, EStencilOperation& dpfail, EStencilOperation& dppass) const;
 
        status_t setCullingMode(ECullMode mode);
 
        status_t setDrawMode(EDrawMode mode);
 
        status_t getCullingMode(ECullMode& mode) const;
 
        status_t getDrawMode(EDrawMode& mode) const;
 
        status_t setColorWriteMask(bool writeRed, bool writeGreen, bool writeBlue, bool writeAlpha);
 
        status_t getColorWriteMask(bool& writeRed, bool& writeGreen, bool& writeBlue, bool& writeAlpha) const;
 
        class AppearanceImpl& impl;
 
        status_t setInputValueInt32(const UniformInput& input, int32_t i);
 
        status_t setInputValueInt32(const UniformInput& input, uint32_t elementCount, const int32_t* values);
 
        status_t getInputValueInt32(const UniformInput& input, int32_t& i) const;
 
        status_t getInputValueInt32(const UniformInput& input, uint32_t elementCount, int32_t* valuesOut) const;
 
 
        status_t setInputValueFloat(const UniformInput& input, float value);
 
        status_t setInputValueFloat(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueFloat(const UniformInput& input, float& valueOut) const;
 
        status_t getInputValueFloat(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueVector2i(const UniformInput& input, int32_t x, int32_t y);
 
        status_t setInputValueVector2i(const UniformInput& input, uint32_t elementCount, const int32_t* values);
 
        status_t getInputValueVector2i(const UniformInput& input, int32_t& x, int32_t& y) const;
 
        status_t getInputValueVector2i(const UniformInput& input, uint32_t elementCount, int32_t* valuesOut) const;
 
        status_t setInputValueVector3i(const UniformInput& input, int32_t x, int32_t y, int32_t z);
 
        status_t setInputValueVector3i(const UniformInput& input, uint32_t elementCount, const int32_t* values);
 
        status_t getInputValueVector3i(const UniformInput& input, int32_t& x, int32_t& y, int32_t& z) const;
 
        status_t getInputValueVector3i(const UniformInput& input, uint32_t elementCount, int32_t* valuesOut) const;
 
        status_t setInputValueVector4i(const UniformInput& input, int32_t x, int32_t y, int32_t z, int32_t w);
 
        status_t setInputValueVector4i(const UniformInput& input, uint32_t elementCount, const int32_t* values);
 
        status_t getInputValueVector4i(const UniformInput& input, int32_t& x, int32_t& y, int32_t& z, int32_t& w) const;
 
        status_t getInputValueVector4i(const UniformInput& input, uint32_t elementCount, int32_t* valuesOut) const;
 
        status_t setInputValueVector2f(const UniformInput& input, float x, float y);
 
        status_t setInputValueVector2f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueVector2f(const UniformInput& input, float& x, float& y) const;
 
        status_t getInputValueVector2f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueVector3f(const UniformInput& input, float x, float y, float z);
 
        status_t setInputValueVector3f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueVector3f(const UniformInput& input, float& x, float& y, float& z) const;
 
        status_t getInputValueVector3f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueVector4f(const UniformInput& input, float x, float y, float z, float w);
 
        status_t setInputValueVector4f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueVector4f(const UniformInput& input, float& x, float& y, float& z, float& w) const;
 
        status_t getInputValueVector4f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueMatrix22f(const UniformInput& input, const float values[4]);
 
        status_t setInputValueMatrix22f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueMatrix22f(const UniformInput& input, float valueOut[4]) const;
 
        status_t getInputValueMatrix22f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueMatrix33f(const UniformInput& input, const float values[9]);
 
        status_t setInputValueMatrix33f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueMatrix33f(const UniformInput& input, float valueOut[9]) const;
 
        status_t getInputValueMatrix33f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputValueMatrix44f(const UniformInput& input, const float values[16]);
 
        status_t setInputValueMatrix44f(const UniformInput& input, uint32_t elementCount, const float* values);
 
        status_t getInputValueMatrix44f(const UniformInput& input, float valueOut[16]) const;
 
        status_t getInputValueMatrix44f(const UniformInput& input, uint32_t elementCount, float* valuesOut) const;
 
        status_t setInputTexture(const UniformInput& input, const TextureSampler& textureSampler);
 
        status_t setInputTexture(const UniformInput& input, const TextureSamplerMS& textureSampler);
 
        status_t setInputTexture(const UniformInput& input, const TextureSamplerExternal& textureSampler);
 
        status_t getInputTexture(const UniformInput& input, const TextureSampler*& textureSampler) const;
 
        status_t getInputTextureMS(const UniformInput& input, const TextureSamplerMS*& textureSampler) const;
 
        status_t getInputTextureExternal(const UniformInput& input, const TextureSamplerExternal*& textureSampler) const;
 
        status_t bindInput(const UniformInput& input, const DataObject& dataObject);
 
        status_t unbindInput(const UniformInput& input);
 
        bool isInputBound(const UniformInput& input) const;
 
        const DataObject* getDataObjectBoundToInput(const UniformInput& input) const;
 
        const Effect& getEffect() const;
 
    protected:
        friend class SceneImpl;
 
        explicit Appearance(AppearanceImpl& pimpl);
 
        Appearance(const Appearance& other);
 
        Appearance& operator=(const Appearance& other);
 
        virtual ~Appearance();
    };
}
 
#endif