gpu/src/gpu/Framebuffer.h

//
//  Framebuffer.h
//  libraries/gpu/src/gpu
//
//  Created by Sam Gateau on 4/12/2015.
//  Copyright 2014 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
#ifndef hifi_gpu_Framebuffer_h
#define hifi_gpu_Framebuffer_h
 
#include "Texture.h"
#include "ResourceSwapChain.h"
#include <memory>
 
class Transform; // Texcood transform util
 
namespace gpu {
 
typedef Element Format;
 
class Framebuffer {
public:
    enum BufferMask {
        BUFFER_COLOR0 = 1,
        BUFFER_COLOR1 = 2,
        BUFFER_COLOR2 = 4,
        BUFFER_COLOR3 = 8,
        BUFFER_COLOR4 = 16,
        BUFFER_COLOR5 = 32,
        BUFFER_COLOR6 = 64,
        BUFFER_COLOR7 = 128,
        BUFFER_COLORS = 0x000000FF,
 
        BUFFER_DEPTH = 0x40000000,
        BUFFER_STENCIL = 0x80000000,
        BUFFER_DEPTHSTENCIL = 0xC0000000,
    };
    typedef uint32 Masks;
 
    ~Framebuffer();
 
    static Framebuffer* create(const std::string& name);
 
    static Framebuffer* create(const std::string& name, const Format& colorBufferFormat, uint16 width, uint16 height);
 
    static Framebuffer* create(const std::string& name, const Format& colorBufferFormat, const Format& depthStencilBufferFormat, uint16 width, uint16 height);
 
    // Render buffers
    void removeRenderBuffers();
 
    uint32 getNumRenderBuffers() const;
 
    const TextureViews& getRenderBuffers() const { return _renderBuffers; }
 
    int32 setRenderBuffer(uint32 slot, const TexturePointer& texture, uint32 subresource = 0);
 
    const TexturePointer& getRenderBuffer(uint32 slot) const;
 
    uint32 getRenderBufferSubresource(uint32 slot) const;
 
    bool setDepthBuffer(const TexturePointer& texture, const Format& format, uint32 subresource = 0);
 
    bool setStencilBuffer(const TexturePointer& texture, const Format& format, uint32 subresource = 0);
 
    bool setDepthStencilBuffer(const TexturePointer& texture, const Format& format, uint32 subresource = 0);
 
    const TexturePointer& getDepthStencilBuffer() const;
 
    uint32 getDepthStencilBufferSubresource() const;
 
    Format getDepthStencilBufferFormat() const;
 
 
    // Properties
    Masks getBufferMask() const { return _bufferMask; }
 
    bool isEmpty() const { return (_bufferMask == 0); }
 
    bool hasColor() const { return (getBufferMask() & BUFFER_COLORS); }
 
    bool hasDepthStencil() const { return (getBufferMask() & BUFFER_DEPTHSTENCIL); }
 
    bool hasDepth() const { return (getBufferMask() & BUFFER_DEPTH); }
 
    bool hasStencil() const { return (getBufferMask() & BUFFER_STENCIL); }
 
    bool validateTargetCompatibility(const Texture& texture, uint32 subresource = 0) const;
 
    Vec2u getSize() const { return Vec2u(getWidth(), getHeight()); }
 
    uint16 getWidth() const;
 
    uint16 getHeight() const;
 
    uint16 getNumSamples() const;
 
    const std::string& getName() const { return _name; }
 
    void setName(const std::string& name) { _name = name; }
 
    float getAspectRatio() const { return getWidth() / (float) getHeight() ; }
 
#if !defined(Q_OS_ANDROID)
    static const uint32 MAX_NUM_RENDER_BUFFERS = 8;
#else    
    static const uint32 MAX_NUM_RENDER_BUFFERS = 4;
#endif
    static uint32 getMaxNumRenderBuffers() { return MAX_NUM_RENDER_BUFFERS; }
 
    const GPUObjectPointer gpuObject {};
 
    Stamp getDepthStamp() const { return _depthStamp; }
 
    const std::vector<Stamp>& getColorStamps() const { return _colorStamps; }
 
    static glm::vec4 evalSubregionTexcoordTransformCoefficients(const glm::ivec2& sourceSurface, const glm::ivec2& destRegionSize, const glm::ivec2& destRegionOffset = glm::ivec2(0));
 
    static glm::vec4 evalSubregionTexcoordTransformCoefficients(const glm::ivec2& sourceSurface, const glm::ivec4& destViewport);
 
    static Transform evalSubregionTexcoordTransform(const glm::ivec2& sourceSurface, const glm::ivec2& destRegionSize, const glm::ivec2& destRegionOffset = glm::ivec2(0));
 
    static Transform evalSubregionTexcoordTransform(const glm::ivec2& sourceSurface, const glm::ivec4& destViewport);
 
protected:
    std::string _name;
 
    Stamp _depthStamp { 0 };
 
    std::vector<Stamp> _colorStamps;
 
    TextureViews _renderBuffers;
 
    TextureView _depthStencilBuffer;
 
    Masks _bufferMask = 0;
 
    uint16 _width = 0;
 
    uint16 _height = 0;
 
    uint16 _numSamples = 0;
 
    void updateSize(const TexturePointer& texture);
 
    bool assignDepthStencilBuffer(const TexturePointer& texture, const Format& format, uint32 subresource);
 
    friend class Serializer;
    friend class Deserializer;
    // Non exposed
    Framebuffer(const Framebuffer& framebuffer) = delete;
    Framebuffer() {}
};
typedef std::shared_ptr<Framebuffer> FramebufferPointer;
typedef ResourceSwapChain<Framebuffer> FramebufferSwapChain;
typedef std::shared_ptr<FramebufferSwapChain> FramebufferSwapChainPointer;
 
}
 
#endif