GraphicsAccessories.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 "GraphicsTypes.h"
#include "Shader.h"
#include "Texture.h"
#include "Buffer.h"
#include "RenderDevice.h"
#include "DebugUtilities.h"

namespace Diligent
{

template<VALUE_TYPE ValType>
struct VALUE_TYPE2CType
{};
    

template<>struct VALUE_TYPE2CType<VT_INT8>  { typedef Int8 CType; };


template<>struct VALUE_TYPE2CType<VT_INT16> { typedef Int16 CType; };


template<>struct VALUE_TYPE2CType<VT_INT32> { typedef Int32 CType; };
    

template<>struct VALUE_TYPE2CType<VT_UINT8> { typedef Uint8 CType; };


template<>struct VALUE_TYPE2CType<VT_UINT16>{ typedef Uint16 CType; };


template<>struct VALUE_TYPE2CType<VT_UINT32>{ typedef Uint32 CType; };

    
template<>struct VALUE_TYPE2CType<VT_FLOAT16>{ typedef Uint16 CType; };


template<>struct VALUE_TYPE2CType<VT_FLOAT32>{ typedef Float32 CType; };


static const Uint32 ValueTypeToSizeMap[] = 
{
    0,
    sizeof(VALUE_TYPE2CType<VT_INT8>    :: CType),
    sizeof(VALUE_TYPE2CType<VT_INT16>   :: CType),
    sizeof(VALUE_TYPE2CType<VT_INT32>   :: CType),
    sizeof(VALUE_TYPE2CType<VT_UINT8>   :: CType),
    sizeof(VALUE_TYPE2CType<VT_UINT16>  :: CType),
    sizeof(VALUE_TYPE2CType<VT_UINT32>  :: CType),
    sizeof(VALUE_TYPE2CType<VT_FLOAT16> :: CType),
    sizeof(VALUE_TYPE2CType<VT_FLOAT32> :: CType)
};
static_assert(VT_NUM_TYPES == VT_FLOAT32 + 1, "Not all value type sizes initialized.");

inline Uint32 GetValueSize(VALUE_TYPE Val)
{
    VERIFY_EXPR(Val < _countof(ValueTypeToSizeMap));
    return ValueTypeToSizeMap[Val];
}

const Char* GetValueTypeString( VALUE_TYPE Val );


const TextureFormatAttribs& GetTextureFormatAttribs(TEXTURE_FORMAT Format);


TEXTURE_FORMAT GetDefaultTextureViewFormat(TEXTURE_FORMAT TextureFormat, TEXTURE_VIEW_TYPE ViewType, Uint32 BindFlags);


inline TEXTURE_FORMAT GetDefaultTextureViewFormat(const TextureDesc &TexDesc, TEXTURE_VIEW_TYPE ViewType)
{
    return GetDefaultTextureViewFormat(TexDesc.Format, ViewType, TexDesc.BindFlags);
}


const Char *GetTexViewTypeLiteralName(TEXTURE_VIEW_TYPE ViewType);


const Char *GetBufferViewTypeLiteralName(BUFFER_VIEW_TYPE ViewType);


const Char *GetShaderTypeLiteralName(SHADER_TYPE ShaderType);



const Char *GetShaderVariableTypeLiteralName(SHADER_VARIABLE_TYPE VarType, bool bGetFullName = false);

inline const Char* GetViewTypeLiteralName(TEXTURE_VIEW_TYPE TexViewType)
{
    return GetTexViewTypeLiteralName( TexViewType );
}

inline const Char* GetViewTypeLiteralName(BUFFER_VIEW_TYPE BuffViewType)
{
    return GetBufferViewTypeLiteralName( BuffViewType );
}

const Char* GetUsageString(USAGE Usage);

const Char* GetResourceDimString( RESOURCE_DIMENSION TexType );

String GetBindFlagsString( Uint32 BindFlags );

String GetCPUAccessFlagsString( Uint32 CpuAccessFlags );

String GetTextureDescString(const TextureDesc &Desc);

String GetBufferDescString(const BufferDesc &Desc);


template<typename TObjectDescType>
String GetObjectDescString( const TObjectDescType& )
{
    return "";
}

template<>
inline String GetObjectDescString( const TextureDesc& TexDesc )
{
    String Str( "Tex desc: " );
    Str += GetTextureDescString( TexDesc );
    return Str;
}

template<>
inline String GetObjectDescString( const BufferDesc& BuffDesc )
{
    String Str( "Buff desc: " );
    Str += GetBufferDescString( BuffDesc );
    return Str;
}

Uint32 ComputeMipLevelsCount( Uint32 Width );
Uint32 ComputeMipLevelsCount( Uint32 Width, Uint32 Height );
Uint32 ComputeMipLevelsCount( Uint32 Width, Uint32 Height, Uint32 Depth );
}