Flags.h

Go to the documentation of this file.

#pragma once
 
#include "Base.h"
 
#include <cstdint>
 
// Require Max 32bit enums for Cogs.js support.
#define COGS_RENDERING_ENABLE_ENUM_FLAGS(EnumType) \
  static_assert(sizeof(EnumType) <= sizeof(uint32_t)); \
  constexpr EnumType operator|(EnumType lhs, EnumType rhs) { return static_cast<EnumType>(static_cast<uint32_t>(lhs) | static_cast<uint32_t>(rhs)); } \
  constexpr EnumType operator&(EnumType lhs, EnumType rhs) { return static_cast<EnumType>(static_cast<uint32_t>(lhs) & static_cast<uint32_t>(rhs)); } \
  constexpr EnumType & operator|=(EnumType & lhs, EnumType rhs) { lhs = static_cast<EnumType>(static_cast<uint32_t>(lhs) | static_cast<uint32_t>(rhs)); return lhs; }
 
namespace Cogs
{
  struct Usage
  {
    enum EUsage
    {
      Default = 0,
      Static,
      Dynamic,
      Staging
    };
  };
 
  struct AccessMode
  {
    enum EAccessMode
    {
      None = 0x00L,
      Read = 0x01L,
      Write = 0x02L,
      ReadWrite = Read | Write,
    };
  };
 
  struct BindFlags
  {
    enum EBindFlags
    {
      None = 0x00L,
      VertexBuffer = 0x01L,
      IndexBuffer  = 0x02L,
      ConstantBuffer = 0x04L,
      StreamOutBuffer = 0x08L,
      ShaderResource = 0x10L,
      RawBuffer = 0x20L,
      StructuredBuffer = 0x40L,
      StructuredBufferWithCounter = 0x80L,
    };
  };
 
  struct MapMode
  {
    enum EMapMode
    {
      Read = 0,
      Write,
      ReadWrite,
      WriteDiscard,
    };
  };
 
  struct TextureFlags
  {
    enum ETextureFlags
    {
      Default =         0x0000,
      Texture =         0x0001,
      RenderTarget =    0x0002,
      DepthBuffer  =    0x0004,
      GenerateMipMaps = 0x0008,
      CubeMap =         0x0010,
      ReadWriteTexture =0x0020,
      ExternalTexture = 0x0040,
      UsageReadStaging = 0x0080,
      UsageWriteStaging = 0x0100,
      NoDelete =        0x0200
    };
  };
 
  COGS_RENDERING_ENABLE_ENUM_FLAGS(TextureFlags::ETextureFlags);
}