GraphicsTypes.h

/*     Copyright 2015-2018 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  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 OF ANY PROPRIETARY RIGHTS.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once


#include "BasicTypes.h"

namespace Diligent
{

    enum VALUE_TYPE : Int32
    {
        VT_UNDEFINED = 0, 
        VT_INT8,          
        VT_INT16,         
        VT_INT32,         
        VT_UINT8,         
        VT_UINT16,        
        VT_UINT32,        
        VT_FLOAT16,       
        VT_FLOAT32,       
        VT_NUM_TYPES      
    };


    enum BIND_FLAGS : Int32
    {
        BIND_NONE               = 0x0L, 
        BIND_VERTEX_BUFFER      = 0x1L, 
        BIND_INDEX_BUFFER       = 0x2L, 
        BIND_UNIFORM_BUFFER     = 0x4L, 
        BIND_SHADER_RESOURCE    = 0x8L, 
        BIND_STREAM_OUTPUT      = 0x10L,
        BIND_RENDER_TARGET      = 0x20L,
        BIND_DEPTH_STENCIL      = 0x40L,
        BIND_UNORDERED_ACCESS   = 0x80L,
        BIND_INDIRECT_DRAW_ARGS = 0x100L
    };


    enum USAGE : Int32
    {
        USAGE_STATIC = 0, 

        USAGE_DEFAULT,

        USAGE_DYNAMIC,

        USAGE_CPU_ACCESSIBLE
    };

    
    enum CPU_ACCESS_FLAG : Int32
    {
        CPU_ACCESS_READ = 0x01, 
        CPU_ACCESS_WRITE = 0x02 
    };


    enum MAP_TYPE : Int32
    {
        MAP_READ = 0x01,       

        MAP_WRITE = 0x02,          

        MAP_READ_WRITE = 0x03
    };


    enum MAP_FLAGS : Int32
    {
        MAP_FLAG_DO_NOT_WAIT = 0x001,

        MAP_FLAG_DISCARD = 0x002,

        MAP_FLAG_DO_NOT_SYNCHRONIZE = 0x004
    };


    enum RESOURCE_DIMENSION : Int32
    {
        RESOURCE_DIM_UNDEFINED = 0, 
        RESOURCE_DIM_BUFFER,            
        RESOURCE_DIM_TEX_1D,            
        RESOURCE_DIM_TEX_1D_ARRAY,      
        RESOURCE_DIM_TEX_2D,            
        RESOURCE_DIM_TEX_2D_ARRAY,      
        RESOURCE_DIM_TEX_3D,            
        RESOURCE_DIM_TEX_CUBE,          
        RESOURCE_DIM_TEX_CUBE_ARRAY,    
        RESOURCE_DIM_NUM_DIMENSIONS     
    };


    enum TEXTURE_VIEW_TYPE : Int32
    {
        TEXTURE_VIEW_UNDEFINED = 0,     

        TEXTURE_VIEW_SHADER_RESOURCE,

        TEXTURE_VIEW_RENDER_TARGET,     

        TEXTURE_VIEW_DEPTH_STENCIL,     

        TEXTURE_VIEW_UNORDERED_ACCESS,  

        TEXTURE_VIEW_NUM_VIEWS          
    };


    enum BUFFER_VIEW_TYPE : Int32
    {
        BUFFER_VIEW_UNDEFINED = 0,

        BUFFER_VIEW_SHADER_RESOURCE,

        BUFFER_VIEW_UNORDERED_ACCESS,

        BUFFER_VIEW_NUM_VIEWS
    };


    enum TEXTURE_FORMAT : Int32
    {
        TEX_FORMAT_UNKNOWN = 0,  
        
        TEX_FORMAT_RGBA32_TYPELESS,

        TEX_FORMAT_RGBA32_FLOAT,  

        TEX_FORMAT_RGBA32_UINT,

        TEX_FORMAT_RGBA32_SINT,  

        TEX_FORMAT_RGB32_TYPELESS,  
                                                  
        TEX_FORMAT_RGB32_FLOAT,  

        TEX_FORMAT_RGB32_UINT,  

        TEX_FORMAT_RGB32_SINT,  

        TEX_FORMAT_RGBA16_TYPELESS,  

        TEX_FORMAT_RGBA16_FLOAT, 

        TEX_FORMAT_RGBA16_UNORM, 

        TEX_FORMAT_RGBA16_UINT, 

        TEX_FORMAT_RGBA16_SNORM, 

        TEX_FORMAT_RGBA16_SINT, 

        TEX_FORMAT_RG32_TYPELESS, 

        TEX_FORMAT_RG32_FLOAT, 

        TEX_FORMAT_RG32_UINT, 

        TEX_FORMAT_RG32_SINT, 

        TEX_FORMAT_R32G8X24_TYPELESS, 

        TEX_FORMAT_D32_FLOAT_S8X24_UINT, 

        TEX_FORMAT_R32_FLOAT_X8X24_TYPELESS, 

        TEX_FORMAT_X32_TYPELESS_G8X24_UINT, 

        TEX_FORMAT_RGB10A2_TYPELESS, 

        TEX_FORMAT_RGB10A2_UNORM, 

        TEX_FORMAT_RGB10A2_UINT, 

        TEX_FORMAT_R11G11B10_FLOAT, 

        TEX_FORMAT_RGBA8_TYPELESS, 

        TEX_FORMAT_RGBA8_UNORM,

        TEX_FORMAT_RGBA8_UNORM_SRGB, 

        TEX_FORMAT_RGBA8_UINT, 

        TEX_FORMAT_RGBA8_SNORM, 

        TEX_FORMAT_RGBA8_SINT, 
        
        TEX_FORMAT_RG16_TYPELESS, 
        
        TEX_FORMAT_RG16_FLOAT, 
        
        TEX_FORMAT_RG16_UNORM, 
        
        TEX_FORMAT_RG16_UINT, 
        
        TEX_FORMAT_RG16_SNORM, 
        
        TEX_FORMAT_RG16_SINT, 
        
        TEX_FORMAT_R32_TYPELESS, 
        
        TEX_FORMAT_D32_FLOAT, 
        
        TEX_FORMAT_R32_FLOAT, 
        
        TEX_FORMAT_R32_UINT, 
        
        TEX_FORMAT_R32_SINT, 
        
        TEX_FORMAT_R24G8_TYPELESS, 
        
        TEX_FORMAT_D24_UNORM_S8_UINT, 
        
        TEX_FORMAT_R24_UNORM_X8_TYPELESS, 
        
        TEX_FORMAT_X24_TYPELESS_G8_UINT, 
        
        TEX_FORMAT_RG8_TYPELESS, 
        
        TEX_FORMAT_RG8_UNORM, 
        
        TEX_FORMAT_RG8_UINT, 
        
        TEX_FORMAT_RG8_SNORM, 
        
        TEX_FORMAT_RG8_SINT, 
        
        TEX_FORMAT_R16_TYPELESS, 
        
        TEX_FORMAT_R16_FLOAT, 
        
        TEX_FORMAT_D16_UNORM, 
        
        TEX_FORMAT_R16_UNORM, 
        
        TEX_FORMAT_R16_UINT, 
        
        TEX_FORMAT_R16_SNORM, 
        
        TEX_FORMAT_R16_SINT, 
        
        TEX_FORMAT_R8_TYPELESS, 
        
        TEX_FORMAT_R8_UNORM, 
        
        TEX_FORMAT_R8_UINT, 
        
        TEX_FORMAT_R8_SNORM, 
        
        TEX_FORMAT_R8_SINT, 
        
        TEX_FORMAT_A8_UNORM, 
        
        TEX_FORMAT_R1_UNORM, 
        
        TEX_FORMAT_RGB9E5_SHAREDEXP, 
        
        TEX_FORMAT_RG8_B8G8_UNORM, 
        
        TEX_FORMAT_G8R8_G8B8_UNORM, 
        
        TEX_FORMAT_BC1_TYPELESS, 
        
        TEX_FORMAT_BC1_UNORM,
        
        TEX_FORMAT_BC1_UNORM_SRGB,
        
        TEX_FORMAT_BC2_TYPELESS, 
        
        TEX_FORMAT_BC2_UNORM,
        
        TEX_FORMAT_BC2_UNORM_SRGB,
        
        TEX_FORMAT_BC3_TYPELESS, 
        
        TEX_FORMAT_BC3_UNORM,
        
        TEX_FORMAT_BC3_UNORM_SRGB,
        
        TEX_FORMAT_BC4_TYPELESS, 
        
        TEX_FORMAT_BC4_UNORM,
        
        TEX_FORMAT_BC4_SNORM,
        
        TEX_FORMAT_BC5_TYPELESS,
        
        TEX_FORMAT_BC5_UNORM,
        
        TEX_FORMAT_BC5_SNORM,
        
        TEX_FORMAT_B5G6R5_UNORM,
        
        TEX_FORMAT_B5G5R5A1_UNORM, 
        
        TEX_FORMAT_BGRA8_UNORM,
        
        TEX_FORMAT_BGRX8_UNORM,
        
        TEX_FORMAT_R10G10B10_XR_BIAS_A2_UNORM,
        
        TEX_FORMAT_BGRA8_TYPELESS,
        
        TEX_FORMAT_BGRA8_UNORM_SRGB,
        
        TEX_FORMAT_BGRX8_TYPELESS,
        
        TEX_FORMAT_BGRX8_UNORM_SRGB,
        
        TEX_FORMAT_BC6H_TYPELESS,
        
        TEX_FORMAT_BC6H_UF16,
        
        TEX_FORMAT_BC6H_SF16,
        
        TEX_FORMAT_BC7_TYPELESS,
        
        TEX_FORMAT_BC7_UNORM,
        
        TEX_FORMAT_BC7_UNORM_SRGB,
        
        TEX_FORMAT_NUM_FORMATS
    };


    enum FILTER_TYPE : Int32
    {
        FILTER_TYPE_UNKNOWN  = 0,           
        FILTER_TYPE_POINT,                  
        FILTER_TYPE_LINEAR,                 
        FILTER_TYPE_ANISOTROPIC,            
        FILTER_TYPE_COMPARISON_POINT,       
        FILTER_TYPE_COMPARISON_LINEAR,      
        FILTER_TYPE_COMPARISON_ANISOTROPIC, 
        FILTER_TYPE_MINIMUM_POINT,          
        FILTER_TYPE_MINIMUM_LINEAR,         
        FILTER_TYPE_MINIMUM_ANISOTROPIC,    
        FILTER_TYPE_MAXIMUM_POINT,          
        FILTER_TYPE_MAXIMUM_LINEAR,         
        FILTER_TYPE_MAXIMUM_ANISOTROPIC,    
        FILTER_TYPE_NUM_FILTERS             
    };


    enum TEXTURE_ADDRESS_MODE : Int32
    {
        TEXTURE_ADDRESS_UNKNOWN = 0,

        TEXTURE_ADDRESS_WRAP    = 1,

        TEXTURE_ADDRESS_MIRROR  = 2,

        TEXTURE_ADDRESS_CLAMP   = 3,

        TEXTURE_ADDRESS_BORDER  = 4,

        TEXTURE_ADDRESS_MIRROR_ONCE = 5,

        TEXTURE_ADDRESS_NUM_MODES
    };


    enum COMPARISON_FUNCTION : Int32
    {
        COMPARISON_FUNC_UNKNOWN = 0,

        COMPARISON_FUNC_NEVER,

        COMPARISON_FUNC_LESS,

        COMPARISON_FUNC_EQUAL,

        COMPARISON_FUNC_LESS_EQUAL,

        COMPARISON_FUNC_GREATER,

        COMPARISON_FUNC_NOT_EQUAL,
        
        COMPARISON_FUNC_GREATER_EQUAL,
        
        COMPARISON_FUNC_ALWAYS,

        COMPARISON_FUNC_NUM_FUNCTIONS
    };


    enum MISC_TEXTURE_FLAG
    {

        MISC_TEXTURE_FLAG_GENERATE_MIPS = 0x01
    };

    struct DeviceObjectAttribs
    {
        const Char* Name;

        DeviceObjectAttribs() : 
            Name(nullptr)
        {}
    };

    struct SwapChainDesc
    {
        Uint32 Width;

        Uint32 Height;
        
        TEXTURE_FORMAT ColorBufferFormat;
        
        TEXTURE_FORMAT DepthBufferFormat;

        Uint32 SamplesCount;

        Uint32 BufferCount;

        Float32 DefaultDepthValue;

        Uint8 DefaultStencilValue;

        SwapChainDesc() :
            Width(0),
            Height(0),
            ColorBufferFormat( TEX_FORMAT_RGBA8_UNORM_SRGB ),
            DepthBufferFormat( TEX_FORMAT_D32_FLOAT ),
            SamplesCount( 1 ),
            BufferCount( 2 ),
            DefaultDepthValue(1.f),
            DefaultStencilValue(0)
        {}
    };

    struct EngineCreationAttribs
    {
        const Char* strShaderCachePath;
        class IMemoryAllocator *pRawMemAllocator;
        EngineCreationAttribs() : 
            strShaderCachePath(nullptr),
            pRawMemAllocator(nullptr)
        {}
    };

    struct EngineD3D12Attribs : public EngineCreationAttribs
    {
        Uint32 CPUDescriptorHeapAllocationSize[4] = 
        {
            1024,  // D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV
            256,   // D3D12_DESCRIPTOR_HEAP_TYPE_SAMPLER
            128,   // D3D12_DESCRIPTOR_HEAP_TYPE_RTV
            64     // D3D12_DESCRIPTOR_HEAP_TYPE_DSV
        };

        Uint32 GPUDescriptorHeapSize[2] = 
        {
            16384,  // D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV
            1024    // D3D12_DESCRIPTOR_HEAP_TYPE_SAMPLER
        };

        Uint32 GPUDescriptorHeapDynamicSize[2] = 
        {
            4096,  // D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV
            1024   // D3D12_DESCRIPTOR_HEAP_TYPE_SAMPLER
        };

        Uint32 DynamicDescriptorAllocationChunkSize[2] = 
        {
            128,  // D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV
            16    // D3D12_DESCRIPTOR_HEAP_TYPE_SAMPLER
        };

        Uint32 NumCommandsToFlushCmdList = 256;
    };

    struct Box
    {
        Uint32 MinX; 
        Uint32 MaxX; 
        Uint32 MinY; 
        Uint32 MaxY; 
        Uint32 MinZ; 
        Uint32 MaxZ; 

        Box(Uint32 _MinX = 0, Uint32 _MaxX = 0,
            Uint32 _MinY = 0, Uint32 _MaxY = 0,
            Uint32 _MinZ = 0, Uint32 _MaxZ = 1) : 
            MinX(_MinX), MaxX(_MaxX),
            MinY(_MinY), MaxY(_MaxY),
            MinZ(_MinZ), MaxZ(_MaxZ)
        {}
    };


    enum COMPONENT_TYPE : Int32
    {
        COMPONENT_TYPE_UNDEFINED,

        COMPONENT_TYPE_FLOAT,

        COMPONENT_TYPE_SNORM,

        COMPONENT_TYPE_UNORM,

        COMPONENT_TYPE_UNORM_SRGB,

        COMPONENT_TYPE_SINT,

        COMPONENT_TYPE_UINT,

        COMPONENT_TYPE_DEPTH,

        COMPONENT_TYPE_DEPTH_STENCIL,

        COMPONENT_TYPE_COMPOUND,

        COMPONENT_TYPE_COMPRESSED,
    };

    struct TextureFormatAttribs
    {
        TEXTURE_FORMAT Format;

        const Char *Name;

        Uint32 ComponentSize;

        Uint32 NumComponents;

        COMPONENT_TYPE ComponentType;    

        explicit TextureFormatAttribs( TEXTURE_FORMAT _Format = TEX_FORMAT_UNKNOWN, 
                                        const Char *_Name = "TEX_FORMAT_UNKNOWN",
                                        Uint32 _ComponentSize = 0,
                                        Uint32 _NumComponents = 0,
                                        COMPONENT_TYPE _ComponentType = COMPONENT_TYPE_UNDEFINED ) : 
            Format(_Format),
            Name(_Name),
            ComponentSize(_ComponentSize),
            NumComponents(_NumComponents),
            ComponentType(_ComponentType)
        {}
    };


    struct TextureFormatInfo : public TextureFormatAttribs
    {
        bool Supported;

        explicit TextureFormatInfo() :
            Supported(false)
        {}
    };


    struct TextureFormatInfoExt : TextureFormatInfo
    {
        bool Filterable;

        bool ColorRenderable;

        bool DepthRenderable;

        bool Tex1DFmt;

        bool Tex2DFmt;

        bool Tex3DFmt;

        bool TexCubeFmt;

        bool SupportsMS;

        explicit TextureFormatInfoExt() : 
            Filterable(false),
            ColorRenderable(false),
            DepthRenderable(false),
            Tex1DFmt(false),
            Tex2DFmt(false),
            Tex3DFmt(false),
            TexCubeFmt(false),
            SupportsMS(false)
        {}
    };
}