RenderPass.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2015 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_RENDERPASS_H
#define RAMSES_RENDERPASS_H
 
#include "ramses-client-api/SceneObject.h"
 
namespace ramses
{
    class Camera;
    class RenderGroup;
    class RenderTarget;
 
    class RAMSES_API RenderPass : public SceneObject
    {
    public:
        status_t setCamera(const Camera& camera);
 
        const Camera* getCamera() const;
 
        Camera* getCamera();
 
        status_t addRenderGroup(const RenderGroup& renderGroup, int32_t orderWithinPass = 0);
 
        status_t removeRenderGroup(const RenderGroup& renderGroup);
 
        bool containsRenderGroup(const RenderGroup& renderGroup) const;
 
        status_t getRenderGroupOrder(const RenderGroup& renderGroup, int32_t& orderWithinPass) const;
 
        status_t removeAllRenderGroups();
 
        status_t setRenderTarget(RenderTarget* renderTarget);
 
        const RenderTarget* getRenderTarget() const;
 
        status_t setRenderOrder(int32_t renderOrder);
 
        int32_t getRenderOrder() const;
 
        status_t setClearColor(float r, float g, float b, float a);
 
        void getClearColor(float &r, float &g, float &b, float &a) const;
 
        status_t setClearFlags(uint32_t clearFlags);
 
        uint32_t getClearFlags() const;
 
        status_t setEnabled(bool enable);
 
        bool isEnabled() const;
 
        status_t setRenderOnce(bool enable);
 
        bool isRenderOnce() const;
 
        status_t retriggerRenderOnce();
 
        class RenderPassImpl& impl;
 
    protected:
        friend class SceneImpl;
 
        explicit RenderPass(RenderPassImpl& pimpl);
 
        virtual ~RenderPass();
    };
}
 
#endif