git.cworth.org Git - apitrace/blob - thirdparty/directxtex/DirectXTex/DDS.h

   1 //--------------------------------------------------------------------------------------
   2 // dds.h
   3 //
   4 // This header defines constants and structures that are useful when parsing
   5 // DDS files.  DDS files were originally designed to use several structures
   6 // and constants that are native to DirectDraw and are defined in ddraw.h,
   7 // such as DDSURFACEDESC2 and DDSCAPS2.  This file defines similar
   8 // (compatible) constants and structures so that one can use DDS files
   9 // without needing to include ddraw.h.
  10 //
  11 // THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
  12 // ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
  13 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  14 // PARTICULAR PURPOSE.
  15 //
  16 // Copyright (c) Microsoft Corporation. All rights reserved.
  17 //
  18 // http://go.microsoft.com/fwlink/?LinkId=248926
  19 //--------------------------------------------------------------------------------------
  20
  21 #if defined(_MSC_VER) && (_MSC_VER > 1000)
  22 #pragma once
  23 #endif
  24
  25 #include <dxgiformat.h>
  26
  27 #pragma warning(push)
  28 #pragma warning(disable : 4005)
  29 #include <stdint.h>
  30 #pragma warning(pop)
  31
  32 namespace DirectX
  33 {
  34
  35 #pragma pack(push,1)
  36
  37 const uint32_t DDS_MAGIC = 0x20534444; // "DDS "
  38
  39 struct DDS_PIXELFORMAT
  40 {
  41     uint32_t    dwSize;
  42     uint32_t    dwFlags;
  43     uint32_t    dwFourCC;
  44     uint32_t    dwRGBBitCount;
  45     uint32_t    dwRBitMask;
  46     uint32_t    dwGBitMask;
  47     uint32_t    dwBBitMask;
  48     uint32_t    dwABitMask;
  49 };
  50
  51 #define DDS_FOURCC      0x00000004  // DDPF_FOURCC
  52 #define DDS_RGB         0x00000040  // DDPF_RGB
  53 #define DDS_RGBA        0x00000041  // DDPF_RGB | DDPF_ALPHAPIXELS
  54 #define DDS_LUMINANCE   0x00020000  // DDPF_LUMINANCE
  55 #define DDS_LUMINANCEA  0x00020001  // DDPF_LUMINANCE | DDPF_ALPHAPIXELS
  56 #define DDS_ALPHA       0x00000002  // DDPF_ALPHA
  57 #define DDS_PAL8        0x00000020  // DDPF_PALETTEINDEXED8
  58
  59 #ifndef MAKEFOURCC
  60     #define MAKEFOURCC(ch0, ch1, ch2, ch3)                              \
  61                 ((uint32_t)(uint8_t)(ch0) | ((uint32_t)(uint8_t)(ch1) << 8) |       \
  62                 ((uint32_t)(uint8_t)(ch2) << 16) | ((uint32_t)(uint8_t)(ch3) << 24 ))
  63 #endif /* defined(MAKEFOURCC) */
  64
  65 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DXT1 =
  66     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','T','1'), 0, 0, 0, 0, 0 };
  67
  68 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DXT2 =
  69     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','T','2'), 0, 0, 0, 0, 0 };
  70
  71 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DXT3 =
  72     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','T','3'), 0, 0, 0, 0, 0 };
  73
  74 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DXT4 =
  75     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','T','4'), 0, 0, 0, 0, 0 };
  76
  77 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DXT5 =
  78     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','T','5'), 0, 0, 0, 0, 0 };
  79
  80 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_BC4_UNORM =
  81     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('B','C','4','U'), 0, 0, 0, 0, 0 };
  82
  83 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_BC4_SNORM =
  84     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('B','C','4','S'), 0, 0, 0, 0, 0 };
  85
  86 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_BC5_UNORM =
  87     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('B','C','5','U'), 0, 0, 0, 0, 0 };
  88
  89 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_BC5_SNORM =
  90     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('B','C','5','S'), 0, 0, 0, 0, 0 };
  91
  92 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_R8G8_B8G8 =
  93     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('R','G','B','G'), 0, 0, 0, 0, 0 };
  94
  95 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_G8R8_G8B8 =
  96     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('G','R','G','B'), 0, 0, 0, 0, 0 };
  97
  98 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A8R8G8B8 =
  99     { sizeof(DDS_PIXELFORMAT), DDS_RGBA, 0, 32, 0x00ff0000, 0x0000ff00, 0x000000ff, 0xff000000 };
 100
 101 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_X8R8G8B8 =
 102     { sizeof(DDS_PIXELFORMAT), DDS_RGB,  0, 32, 0x00ff0000, 0x0000ff00, 0x000000ff, 0x00000000 };
 103
 104 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A8B8G8R8 =
 105     { sizeof(DDS_PIXELFORMAT), DDS_RGBA, 0, 32, 0x000000ff, 0x0000ff00, 0x00ff0000, 0xff000000 };
 106
 107 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_X8B8G8R8 =
 108     { sizeof(DDS_PIXELFORMAT), DDS_RGB,  0, 32, 0x000000ff, 0x0000ff00, 0x00ff0000, 0x00000000 };
 109
 110 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_G16R16 =
 111     { sizeof(DDS_PIXELFORMAT), DDS_RGB,  0, 32, 0x0000ffff, 0xffff0000, 0x00000000, 0x00000000 };
 112
 113 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_R5G6B5 =
 114     { sizeof(DDS_PIXELFORMAT), DDS_RGB, 0, 16, 0x0000f800, 0x000007e0, 0x0000001f, 0x00000000 };
 115
 116 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A1R5G5B5 =
 117     { sizeof(DDS_PIXELFORMAT), DDS_RGBA, 0, 16, 0x00007c00, 0x000003e0, 0x0000001f, 0x00008000 };
 118
 119 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A4R4G4B4 =
 120     { sizeof(DDS_PIXELFORMAT), DDS_RGBA, 0, 16, 0x00000f00, 0x000000f0, 0x0000000f, 0x0000f000 };
 121
 122 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_R8G8B8 =
 123     { sizeof(DDS_PIXELFORMAT), DDS_RGB, 0, 24, 0x00ff0000, 0x0000ff00, 0x000000ff, 0x00000000 };
 124
 125 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_L8 =
 126     { sizeof(DDS_PIXELFORMAT), DDS_LUMINANCE, 0,  8, 0xff, 0x00, 0x00, 0x00 };
 127
 128 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_L16 =
 129     { sizeof(DDS_PIXELFORMAT), DDS_LUMINANCE, 0, 16, 0xffff, 0x0000, 0x0000, 0x0000 };
 130
 131 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A8L8 =
 132     { sizeof(DDS_PIXELFORMAT), DDS_LUMINANCEA, 0, 16, 0x00ff, 0x0000, 0x0000, 0xff00 };
 133
 134 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_A8 =
 135     { sizeof(DDS_PIXELFORMAT), DDS_ALPHA, 0, 8, 0x00, 0x00, 0x00, 0xff };
 136
 137 // D3DFMT_A2R10G10B10/D3DFMT_A2B10G10R10 should be written using DX10 extension to avoid D3DX 10:10:10:2 reversal issue
 138
 139 // This indicates the DDS_HEADER_DXT10 extension is present (the format is in dxgiFormat)
 140 extern __declspec(selectany) const DDS_PIXELFORMAT DDSPF_DX10 =
 141     { sizeof(DDS_PIXELFORMAT), DDS_FOURCC, MAKEFOURCC('D','X','1','0'), 0, 0, 0, 0, 0 };
 142
 143 #define DDS_HEADER_FLAGS_TEXTURE        0x00001007  // DDSD_CAPS | DDSD_HEIGHT | DDSD_WIDTH | DDSD_PIXELFORMAT
 144 #define DDS_HEADER_FLAGS_MIPMAP         0x00020000  // DDSD_MIPMAPCOUNT
 145 #define DDS_HEADER_FLAGS_VOLUME         0x00800000  // DDSD_DEPTH
 146 #define DDS_HEADER_FLAGS_PITCH          0x00000008  // DDSD_PITCH
 147 #define DDS_HEADER_FLAGS_LINEARSIZE     0x00080000  // DDSD_LINEARSIZE
 148
 149 #define DDS_HEIGHT 0x00000002 // DDSD_HEIGHT
 150 #define DDS_WIDTH  0x00000004 // DDSD_WIDTH
 151
 152 #define DDS_SURFACE_FLAGS_TEXTURE 0x00001000 // DDSCAPS_TEXTURE
 153 #define DDS_SURFACE_FLAGS_MIPMAP  0x00400008 // DDSCAPS_COMPLEX | DDSCAPS_MIPMAP
 154 #define DDS_SURFACE_FLAGS_CUBEMAP 0x00000008 // DDSCAPS_COMPLEX
 155
 156 #define DDS_CUBEMAP_POSITIVEX 0x00000600 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_POSITIVEX
 157 #define DDS_CUBEMAP_NEGATIVEX 0x00000a00 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_NEGATIVEX
 158 #define DDS_CUBEMAP_POSITIVEY 0x00001200 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_POSITIVEY
 159 #define DDS_CUBEMAP_NEGATIVEY 0x00002200 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_NEGATIVEY
 160 #define DDS_CUBEMAP_POSITIVEZ 0x00004200 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_POSITIVEZ
 161 #define DDS_CUBEMAP_NEGATIVEZ 0x00008200 // DDSCAPS2_CUBEMAP | DDSCAPS2_CUBEMAP_NEGATIVEZ
 162
 163 #define DDS_CUBEMAP_ALLFACES ( DDS_CUBEMAP_POSITIVEX | DDS_CUBEMAP_NEGATIVEX |\
 164                                DDS_CUBEMAP_POSITIVEY | DDS_CUBEMAP_NEGATIVEY |\
 165                                DDS_CUBEMAP_POSITIVEZ | DDS_CUBEMAP_NEGATIVEZ )
 166
 167 #define DDS_CUBEMAP 0x00000200 // DDSCAPS2_CUBEMAP
 168
 169 #define DDS_FLAGS_VOLUME 0x00200000 // DDSCAPS2_VOLUME
 170
 171 // Subset here matches D3D10_RESOURCE_DIMENSION and D3D11_RESOURCE_DIMENSION
 172 typedef enum DDS_RESOURCE_DIMENSION
 173 {
 174     DDS_DIMENSION_TEXTURE1D     = 2,
 175     DDS_DIMENSION_TEXTURE2D     = 3,
 176     DDS_DIMENSION_TEXTURE3D     = 4,
 177 } DDS_RESOURCE_DIMENSION;
 178
 179 // Subset here matches D3D10_RESOURCE_MISC_FLAG and D3D11_RESOURCE_MISC_FLAG
 180 typedef enum DDS_RESOURCE_MISC_FLAG
 181 {
 182    DDS_RESOURCE_MISC_TEXTURECUBE = 0x4L,
 183 } DDS_RESOURCE_MISC_FLAG;
 184
 185 typedef struct
 186 {
 187     uint32_t    dwSize;
 188     uint32_t    dwFlags;
 189     uint32_t    dwHeight;
 190     uint32_t    dwWidth;
 191     uint32_t    dwPitchOrLinearSize;
 192     uint32_t    dwDepth; // only if DDS_HEADER_FLAGS_VOLUME is set in dwFlags
 193     uint32_t    dwMipMapCount;
 194     uint32_t    dwReserved1[11];
 195     DDS_PIXELFORMAT ddspf;
 196     uint32_t    dwCaps;
 197     uint32_t    dwCaps2;
 198     uint32_t    dwCaps3;
 199     uint32_t    dwCaps4;
 200     uint32_t    dwReserved2;
 201 } DDS_HEADER;
 202
 203 typedef struct
 204 {
 205     DXGI_FORMAT dxgiFormat;
 206     uint32_t    resourceDimension;
 207     uint32_t    miscFlag; // see DDS_RESOURCE_MISC_FLAG
 208     uint32_t    arraySize;
 209     uint32_t    reserved;
 210 } DDS_HEADER_DXT10;
 211
 212 #pragma pack(pop)
 213
 214 }; // namespace