surfacedescriptor.h

/* 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/. */
 
#pragma once
 
#include "rtti/typeinfo.h"
 
// External Includes
 
namespace nap
{
    enum class ESurfaceDataType : int
    {
        BYTE        = 0,    
        USHORT      = 1,    
        FLOAT       = 2     
    };
 
    enum class ESurfaceChannels : int
    {
        R           = 0,    
        RGBA        = 1,    
        BGRA        = 2,    
        D           = 3     
    };
 
    enum class EColorSpace : int
    {
        Linear,             
        sRGB                
    };
 
    struct NAPAPI SurfaceDescriptor
    {
        RTTI_ENABLE()
 
    public:
        SurfaceDescriptor() = default;
        virtual ~SurfaceDescriptor() = default;
        SurfaceDescriptor(uint32_t width, uint32_t height, ESurfaceDataType dataType, ESurfaceChannels channels);
        SurfaceDescriptor(uint32_t width, uint32_t height, ESurfaceDataType dataType, ESurfaceChannels channels, EColorSpace colorSpace);
 
        int getWidth() const                                            { return mWidth; }
 
        int getHeight() const                                           { return mHeight; }
        
        int getPitch() const;
        
        int getNumChannels() const;
 
        int getChannelSize() const;
        
        int getBytesPerPixel() const;
 
        uint64_t getSizeInBytes() const;
 
        ESurfaceDataType getDataType() const                            { return mDataType; }
 
        ESurfaceChannels getChannels() const                            { return mChannels; }
 
        EColorSpace getColorSpace() const                               { return mColorSpace; }
 
        bool isValid() const { return mWidth != 0 && mHeight != 0; }
 
        bool operator==(const SurfaceDescriptor& other) const;
        bool operator!=(const SurfaceDescriptor& other) const;
 
    public:
        uint32_t            mWidth = 0;                                 
        uint32_t            mHeight = 0;                                
        ESurfaceDataType    mDataType = nap::ESurfaceDataType::BYTE;    
        ESurfaceChannels    mChannels = nap::ESurfaceChannels::BGRA;    
        EColorSpace         mColorSpace = EColorSpace::Linear;          
    };
}
 
namespace std
{
    template <>
    struct hash<nap::ESurfaceChannels>
    {
        size_t operator()(const nap::ESurfaceChannels& v) const
        {
            return hash<int>()(static_cast<int>(v));
        }
    };
 
    template <>
    struct hash<nap::ESurfaceDataType>
    {
        size_t operator()(const nap::ESurfaceDataType& v) const
        {
            return hash<int>()(static_cast<int>(v));
        }
    };
 
    template <>
    struct hash<nap::EColorSpace>
    {
        size_t operator()(const nap::EColorSpace& v) const
        {
            return hash<int>()(static_cast<int>(v));
        }
    };
}