dfdutils/dfd.h at main · KhronosGroup/dfdutils · GitHub

History

236 lines (197 loc) · 9.62 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

/* -*- tab-width: 4; -*- */

/* vi: set sw=2 ts=4 expandtab: */

* SPDX-License-Identifier: Apache-2.0

/**

* @file

* @~English

* @brief Header file defining the data format descriptor utilities API.

* Author: Andrew Garrard

#ifndef DFD_H_

#define DFD_H_

#include <KHR/khr_df.h>

#include <stdbool.h>

#ifdef __cplusplus

extern "C" {

#endif

/** Qualifier suffix to the format, in Vulkan terms. */

enum VkSuffix {

s_UNORM, /*!< Unsigned normalized format. */

s_SNORM, /*!< Signed normalized format. */

s_USCALED, /*!< Unsigned scaled format. */

s_SSCALED, /*!< Signed scaled format. */

s_UINT, /*!< Unsigned integer format. */

s_SINT, /*!< Signed integer format. */

s_SFLOAT, /*!< Signed float format. */

s_UFLOAT, /*!< Unsigned float format. */

s_SRGB, /*!< sRGB normalized format. */

s_SFIXED5 /*!< 2's complement fixed-point; 5 fractional bits. */

};

/** Compression scheme, in Vulkan terms. */

enum VkCompScheme {

c_BC1_RGB, /*!< BC1, aka DXT1, no alpha. */

c_BC1_RGBA, /*!< BC1, aka DXT1, punch-through alpha. */

c_BC2, /*!< BC2, aka DXT2 and DXT3. */

c_BC3, /*!< BC3, aka DXT4 and DXT5. */

c_BC4, /*!< BC4. */

c_BC5, /*!< BC5. */

c_BC6H, /*!< BC6h HDR format. */

c_BC7, /*!< BC7. */

c_ETC2_R8G8B8, /*!< ETC2 no alpha. */

c_ETC2_R8G8B8A1, /*!< ETC2 punch-through alpha. */

c_ETC2_R8G8B8A8, /*!< ETC2 independent alpha. */

c_EAC_R11, /*!< R11 ETC2 single-channel. */

c_EAC_R11G11, /*!< R11G11 ETC2 dual-channel. */

c_ASTC, /*!< ASTC. */

c_ETC1S, /*!< ETC1S. */

c_PVRTC, /*!< PVRTC(1). */

c_PVRTC2 /*!< PVRTC2. */

};

typedef unsigned int uint32_t;

#if !defined(LIBKTX)

#include <vulkan/vulkan_core.h>

#else

#include "../../lib/src/vkformat_enum.h"

#endif

uint32_t* vk2dfd(enum VkFormat format);

enum VkFormat dfd2vk(uint32_t* dfd);

/* Create a Data Format Descriptor for an unpacked format. */

uint32_t *createDFDUnpacked(int bigEndian, int numChannels, int bytes,

int redBlueSwap, enum VkSuffix suffix);

/* Create a Data Format Descriptor for a packed padded format. */

uint32_t *createDFDPackedShifted(int bigEndian, int numChannels,

int bits[], int shiftBits[],

int channels[], enum VkSuffix suffix);

/* Create a Data Format Descriptor for a packed format. */

uint32_t *createDFDPacked(int bigEndian, int numChannels,

int bits[], int channels[],

enum VkSuffix suffix);

/* Create a Data Format Descriptor for a 4:2:2 format. */

uint32_t *createDFD422(int bigEndian, int numChannels,

int bits[], int shiftBits[], int channels[],

int position_xs[], int position_ys[],

enum VkSuffix suffix);

/* Create a Data Format Descriptor for a compressed format. */

uint32_t *createDFDCompressed(enum VkCompScheme compScheme,

int bwidth, int bheight, int bdepth,

enum VkSuffix suffix);

/* Create a Data Format Descriptor for a depth/stencil format. */

uint32_t *createDFDDepthStencil(int depthBits,

int stencilBits,

int sizeBytes);

/* Create a Data Format Descriptor for an alpha-only format */

uint32_t *createDFDAlpha(int bigEndian, int bytes,

enum VkSuffix suffix);

/** @brief Result of interpreting the data format descriptor. */

enum InterpretDFDResult {

i_LITTLE_ENDIAN_FORMAT_BIT = 0, /*!< Confirmed little-endian (default for 8bpc). */

i_BIG_ENDIAN_FORMAT_BIT = 1u << 0u, /*!< Confirmed big-endian. */

i_PACKED_FORMAT_BIT = 1u << 1u, /*!< Packed format. */

i_SRGB_FORMAT_BIT = 1u << 2u, /*!< sRGB transfer function. */

i_NORMALIZED_FORMAT_BIT = 1u << 3u, /*!< Normalized (UNORM or SNORM). */

i_SIGNED_FORMAT_BIT = 1u << 4u, /*!< Format is signed. */

i_FIXED_FORMAT_BIT = 1u << 5u, /*!< Format is a fixed-point representation. */

i_FLOAT_FORMAT_BIT = 1u << 6u, /*!< Format is floating point. */

i_COMPRESSED_FORMAT_BIT = 1u << 7u, /*!< Format is block compressed (422). */

i_YUVSDA_FORMAT_BIT = 1u << 8u, /*!< Color model is YUVSDA. */

i_UNSUPPORTED_ERROR_BIT = 1u << 9u, /*!< Format not successfully interpreted. */

/** "NONTRIVIAL_ENDIANNESS" means not big-endian, not little-endian

* (a channel has bits that are not consecutive in either order). **/

i_UNSUPPORTED_NONTRIVIAL_ENDIANNESS = i_UNSUPPORTED_ERROR_BIT,

/** "MULTIPLE_SAMPLE_LOCATIONS" is an error because only single-sample

* texel blocks (with coordinates 0,0,0,0 for all samples) are supported. **/

i_UNSUPPORTED_MULTIPLE_SAMPLE_LOCATIONS = i_UNSUPPORTED_ERROR_BIT + 1,

/** "MULTIPLE_PLANES" is an error because only contiguous data is supported. */

i_UNSUPPORTED_MULTIPLE_PLANES = i_UNSUPPORTED_ERROR_BIT + 2,

/** Only channels R, G, B and A are supported. */

i_UNSUPPORTED_CHANNEL_TYPES = i_UNSUPPORTED_ERROR_BIT + 3,

/** Only channels with the same flags are supported

* (e.g. we don't support float red with integer green). */

i_UNSUPPORTED_MIXED_CHANNELS = i_UNSUPPORTED_ERROR_BIT + 4,

/** Only 2x1 block is supported for YUVSDA model. */

i_UNSUPPORTED_BLOCK_DIMENSIONS = i_UNSUPPORTED_ERROR_BIT + 5,

};

/** @brief Interpretation of a channel from the data format descriptor. */

typedef struct _InterpretedDFDChannel {

uint32_t offset; /*!< Offset in bits for packed, bytes for unpacked. */

uint32_t size; /*!< Size in bits for packed, bytes for unpacked. */

} InterpretedDFDChannel;

/* Interpret a Data Format Descriptor. */

enum InterpretDFDResult interpretDFD(const uint32_t *DFD,

InterpretedDFDChannel *R,

InterpretedDFDChannel *G,

InterpretedDFDChannel *B,

InterpretedDFDChannel *A,

uint32_t *wordBytes);

/* Returns the string representation.