RTAttachment.h

Go to the documentation of this file.

/*
Copyright (c) 2018 DIVIDE-Studio
Copyright (c) 2009 Ionut Cava
 
This file is part of DIVIDE Framework.
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software
and associated documentation files (the "Software"), to deal in the Software
without restriction,
including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
*/
 
#pragma once
#ifndef DVD_RENDER_TARGET_ATTACHMENT_H_
#define DVD_RENDER_TARGET_ATTACHMENT_H_
 
#include "Platform/Video/Textures/Headers/TextureDescriptor.h"
#include "Platform/Video/Textures/Headers/SamplerDescriptor.h"
#include "Utility/Headers/Colours.h"
 
namespace Divide {
 
class Texture;
FWD_DECLARE_MANAGED_CLASS(RTAttachment);
 
 
enum class RTAttachmentType : U8 {
    COLOUR = 0,
    DEPTH,
    DEPTH_STENCIL,
    COUNT
};
 
struct RTAttachmentDescriptor
{
    explicit RTAttachmentDescriptor( const SamplerDescriptor sampler, const RTAttachmentType type, const RTColourAttachmentSlot slot, const bool autoResolve) noexcept
        : _sampler(sampler)
        , _type(type)
        , _slot(slot)
        , _autoResolve(autoResolve)
    {
    }
 
    SamplerDescriptor _sampler{};
    RTAttachment* _externalAttachment{nullptr};
    RTAttachmentType _type{ RTAttachmentType::COUNT };
    RTColourAttachmentSlot _slot{ RTColourAttachmentSlot::COUNT };
    bool _autoResolve{true};
};
 
constexpr static U32 RT_DEPTH_ATTACHMENT_IDX = to_base( RTColourAttachmentSlot::COUNT );
constexpr static U8 RT_MAX_ATTACHMENT_COUNT = to_base( RTColourAttachmentSlot::COUNT ) + 1;
 
// External attachments get added last and OVERRIDE any normal attachments found at the same type+index location
struct ExternalRTAttachmentDescriptor final : public RTAttachmentDescriptor
{
    explicit ExternalRTAttachmentDescriptor(RTAttachment* attachment,
                                            const SamplerDescriptor sampler,
                                            const RTAttachmentType type,
                                            const RTColourAttachmentSlot slot,
                                            bool autoResolve = true )
        : RTAttachmentDescriptor(sampler, type, slot, autoResolve)
    {
        _externalAttachment = attachment;
    }
};
 
struct InternalRTAttachmentDescriptor final : public RTAttachmentDescriptor
{
    explicit InternalRTAttachmentDescriptor(TextureDescriptor& descriptor,
                                            const SamplerDescriptor sampler,
                                            const RTAttachmentType type,
                                            const RTColourAttachmentSlot slot,
                                            bool autoResolve = true)
        : RTAttachmentDescriptor(sampler, type, slot, autoResolve)
        , _texDescriptor(descriptor)
    {
    }
 
    TextureDescriptor _texDescriptor;
};
 
using InternalRTAttachmentDescriptors = eastl::fixed_vector<InternalRTAttachmentDescriptor, RT_MAX_ATTACHMENT_COUNT, false>;
using ExternalRTAttachmentDescriptors = eastl::fixed_vector<ExternalRTAttachmentDescriptor, RT_MAX_ATTACHMENT_COUNT, false>;
 
class RenderTarget;
class RTAttachment final
{
    public:
        enum class Layout : U8
        {
            UNDEFINED = 0u,
            ATTACHMENT,
            SHADER_READ
        };
 
    public:
        explicit RTAttachment(RenderTarget& parent, const RTAttachmentDescriptor& descriptor) noexcept;
        ~RTAttachment();
 
        [[nodiscard]] Handle<Texture> texture() const;
 
        void setTexture( Handle<Texture> renderTexture, Handle<Texture> resolveTexture) noexcept;
 
        RenderTarget& parent() noexcept;
        [[nodiscard]] const RenderTarget& parent() const noexcept;
 
        RTAttachmentDescriptor _descriptor;
        Layout _attachmentUsage{ Layout::UNDEFINED };
 
        PROPERTY_R_IW(Handle<Texture>, renderTexture, INVALID_HANDLE<Texture> );
        PROPERTY_R_IW(Handle<Texture>, resolvedTexture, INVALID_HANDLE<Texture> );
 
        PROPERTY_RW(U32, binding, 0u);
        PROPERTY_RW(bool, changed, false);
 
    protected:
        RenderTarget& _parent;
};
 
FWD_DECLARE_MANAGED_CLASS(RTAttachment);
 
}; //namespace Divide
 
#endif //DVD_RENDER_TARGET_ATTACHMENT_H_