ktx2/
enums.rs

1use core::{
2    fmt,
3    num::{NonZeroU32, NonZeroU8},
4};
5
6macro_rules! pseudo_enum {
7    ($(#[$attr:meta])* $container:ident($prim:ident) $name:ident { $($case:ident = $value:literal,)* }) => {
8        $(#[$attr])*
9        #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
10        pub struct $name($container);
11
12        #[allow(non_upper_case_globals)]
13        impl $name {
14            pub fn new(x: $prim) -> Option<Self> {
15                Some(Self($container::new(x)?))
16            }
17
18            pub fn value(&self) -> $prim {
19                self.0.get()
20            }
21
22            $(
23                pub const $case: Self = Self(unsafe { $container::new_unchecked($value) });
24            )*
25        }
26
27        impl fmt::Debug for $name {
28            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
29                let name = match self.0.get() {
30                    $($value => Some(stringify!($case)),)*
31                    _ => None,
32                };
33                match name {
34                    Some(name) => f.pad(name),
35                    None => write!(f, concat!(stringify!($name), "({})"), self.0.get()),
36                }
37            }
38        }
39    };
40}
41
42pseudo_enum! {
43    /// Known texture formats
44    NonZeroU32(u32) Format {
45        R4G4_UNORM_PACK8 = 1,
46        R4G4B4A4_UNORM_PACK16 = 2,
47        B4G4R4A4_UNORM_PACK16 = 3,
48        R5G6B5_UNORM_PACK16 = 4,
49        B5G6R5_UNORM_PACK16 = 5,
50        R5G5B5A1_UNORM_PACK16 = 6,
51        B5G5R5A1_UNORM_PACK16 = 7,
52        A1R5G5B5_UNORM_PACK16 = 8,
53        R8_UNORM = 9,
54        R8_SNORM = 10,
55        R8_UINT = 13,
56        R8_SINT = 14,
57        R8_SRGB = 15,
58        R8G8_UNORM = 16,
59        R8G8_SNORM = 17,
60        R8G8_UINT = 20,
61        R8G8_SINT = 21,
62        R8G8_SRGB = 22,
63        R8G8B8_UNORM = 23,
64        R8G8B8_SNORM = 24,
65        R8G8B8_UINT = 27,
66        R8G8B8_SINT = 28,
67        R8G8B8_SRGB = 29,
68        B8G8R8_UNORM = 30,
69        B8G8R8_SNORM = 31,
70        B8G8R8_UINT = 34,
71        B8G8R8_SINT = 35,
72        B8G8R8_SRGB = 36,
73        R8G8B8A8_UNORM = 37,
74        R8G8B8A8_SNORM = 38,
75        R8G8B8A8_UINT = 41,
76        R8G8B8A8_SINT = 42,
77        R8G8B8A8_SRGB = 43,
78        B8G8R8A8_UNORM = 44,
79        B8G8R8A8_SNORM = 45,
80        B8G8R8A8_UINT = 48,
81        B8G8R8A8_SINT = 49,
82        B8G8R8A8_SRGB = 50,
83        A2R10G10B10_UNORM_PACK32 = 58,
84        A2R10G10B10_SNORM_PACK32 = 59,
85        A2R10G10B10_UINT_PACK32 = 62,
86        A2R10G10B10_SINT_PACK32 = 63,
87        A2B10G10R10_UNORM_PACK32 = 64,
88        A2B10G10R10_SNORM_PACK32 = 65,
89        A2B10G10R10_UINT_PACK32 = 68,
90        A2B10G10R10_SINT_PACK32 = 69,
91        R16_UNORM = 70,
92        R16_SNORM = 71,
93        R16_UINT = 74,
94        R16_SINT = 75,
95        R16_SFLOAT = 76,
96        R16G16_UNORM = 77,
97        R16G16_SNORM = 78,
98        R16G16_UINT = 81,
99        R16G16_SINT = 82,
100        R16G16_SFLOAT = 83,
101        R16G16B16_UNORM = 84,
102        R16G16B16_SNORM = 85,
103        R16G16B16_UINT = 88,
104        R16G16B16_SINT = 89,
105        R16G16B16_SFLOAT = 90,
106        R16G16B16A16_UNORM = 91,
107        R16G16B16A16_SNORM = 92,
108        R16G16B16A16_UINT = 95,
109        R16G16B16A16_SINT = 96,
110        R16G16B16A16_SFLOAT = 97,
111        R32_UINT = 98,
112        R32_SINT = 99,
113        R32_SFLOAT = 100,
114        R32G32_UINT = 101,
115        R32G32_SINT = 102,
116        R32G32_SFLOAT = 103,
117        R32G32B32_UINT = 104,
118        R32G32B32_SINT = 105,
119        R32G32B32_SFLOAT = 106,
120        R32G32B32A32_UINT = 107,
121        R32G32B32A32_SINT = 108,
122        R32G32B32A32_SFLOAT = 109,
123        R64_UINT = 110,
124        R64_SINT = 111,
125        R64_SFLOAT = 112,
126        R64G64_UINT = 113,
127        R64G64_SINT = 114,
128        R64G64_SFLOAT = 115,
129        R64G64B64_UINT = 116,
130        R64G64B64_SINT = 117,
131        R64G64B64_SFLOAT = 118,
132        R64G64B64A64_UINT = 119,
133        R64G64B64A64_SINT = 120,
134        R64G64B64A64_SFLOAT = 121,
135        B10G11R11_UFLOAT_PACK32 = 122,
136        E5B9G9R9_UFLOAT_PACK32 = 123,
137        D16_UNORM = 124,
138        X8_D24_UNORM_PACK32 = 125,
139        D32_SFLOAT = 126,
140        S8_UINT = 127,
141        D16_UNORM_S8_UINT = 128,
142        D24_UNORM_S8_UINT = 129,
143        D32_SFLOAT_S8_UINT = 130,
144        BC1_RGB_UNORM_BLOCK = 131,
145        BC1_RGB_SRGB_BLOCK = 132,
146        BC1_RGBA_UNORM_BLOCK = 133,
147        BC1_RGBA_SRGB_BLOCK = 134,
148        BC2_UNORM_BLOCK = 135,
149        BC2_SRGB_BLOCK = 136,
150        BC3_UNORM_BLOCK = 137,
151        BC3_SRGB_BLOCK = 138,
152        BC4_UNORM_BLOCK = 139,
153        BC4_SNORM_BLOCK = 140,
154        BC5_UNORM_BLOCK = 141,
155        BC5_SNORM_BLOCK = 142,
156        BC6H_UFLOAT_BLOCK = 143,
157        BC6H_SFLOAT_BLOCK = 144,
158        BC7_UNORM_BLOCK = 145,
159        BC7_SRGB_BLOCK = 146,
160        ETC2_R8G8B8_UNORM_BLOCK = 147,
161        ETC2_R8G8B8_SRGB_BLOCK = 148,
162        ETC2_R8G8B8A1_UNORM_BLOCK = 149,
163        ETC2_R8G8B8A1_SRGB_BLOCK = 150,
164        ETC2_R8G8B8A8_UNORM_BLOCK = 151,
165        ETC2_R8G8B8A8_SRGB_BLOCK = 152,
166        EAC_R11_UNORM_BLOCK = 153,
167        EAC_R11_SNORM_BLOCK = 154,
168        EAC_R11G11_UNORM_BLOCK = 155,
169        EAC_R11G11_SNORM_BLOCK = 156,
170        ASTC_4x4_UNORM_BLOCK = 157,
171        ASTC_4x4_SRGB_BLOCK = 158,
172        ASTC_5x4_UNORM_BLOCK = 159,
173        ASTC_5x4_SRGB_BLOCK = 160,
174        ASTC_5x5_UNORM_BLOCK = 161,
175        ASTC_5x5_SRGB_BLOCK = 162,
176        ASTC_6x5_UNORM_BLOCK = 163,
177        ASTC_6x5_SRGB_BLOCK = 164,
178        ASTC_6x6_UNORM_BLOCK = 165,
179        ASTC_6x6_SRGB_BLOCK = 166,
180        ASTC_8x5_UNORM_BLOCK = 167,
181        ASTC_8x5_SRGB_BLOCK = 168,
182        ASTC_8x6_UNORM_BLOCK = 169,
183        ASTC_8x6_SRGB_BLOCK = 170,
184        ASTC_8x8_UNORM_BLOCK = 171,
185        ASTC_8x8_SRGB_BLOCK = 172,
186        ASTC_10x5_UNORM_BLOCK = 173,
187        ASTC_10x5_SRGB_BLOCK = 174,
188        ASTC_10x6_UNORM_BLOCK = 175,
189        ASTC_10x6_SRGB_BLOCK = 176,
190        ASTC_10x8_UNORM_BLOCK = 177,
191        ASTC_10x8_SRGB_BLOCK = 178,
192        ASTC_10x10_UNORM_BLOCK = 179,
193        ASTC_10x10_SRGB_BLOCK = 180,
194        ASTC_12x10_UNORM_BLOCK = 181,
195        ASTC_12x10_SRGB_BLOCK = 182,
196        ASTC_12x12_UNORM_BLOCK = 183,
197        ASTC_12x12_SRGB_BLOCK = 184,
198        ASTC_4x4_SFLOAT_BLOCK = 1000066000,
199        ASTC_5x4_SFLOAT_BLOCK = 1000066001,
200        ASTC_5x5_SFLOAT_BLOCK = 1000066002,
201        ASTC_6x5_SFLOAT_BLOCK = 1000066003,
202        ASTC_6x6_SFLOAT_BLOCK = 1000066004,
203        ASTC_8x5_SFLOAT_BLOCK = 1000066005,
204        ASTC_8x6_SFLOAT_BLOCK = 1000066006,
205        ASTC_8x8_SFLOAT_BLOCK = 1000066007,
206        ASTC_10x5_SFLOAT_BLOCK = 1000066008,
207        ASTC_10x6_SFLOAT_BLOCK = 1000066009,
208        ASTC_10x8_SFLOAT_BLOCK = 1000066010,
209        ASTC_10x10_SFLOAT_BLOCK = 1000066011,
210        ASTC_12x10_SFLOAT_BLOCK = 1000066012,
211        ASTC_12x12_SFLOAT_BLOCK = 1000066013,
212    }
213}
214
215pseudo_enum! {
216    /// Known supercompression schemes
217    NonZeroU32(u32) SupercompressionScheme {
218        BasisLZ = 1,
219        Zstandard = 2,
220        ZLIB = 3,
221    }
222}
223
224pseudo_enum! {
225    NonZeroU8(u8) ColorModel {
226        RGBSDA = 1,
227        YUVSDA = 2,
228        YIQSDA = 3,
229        LabSDA = 4,
230        CMYKA = 5,
231        XYZW = 6,
232        HSVAAng = 7,
233        HSLAAng = 8,
234        HSVAHex = 9,
235        HSLAHex = 10,
236        YCgCoA = 11,
237        YcCbcCrc = 12,
238        ICtCp = 13,
239        CIEXYZ = 14,
240        CIEXYY = 15,
241        BC1A = 128,
242        BC2 = 129,
243        BC3 = 130,
244        BC4 = 131,
245        BC5 = 132,
246        BC6H = 133,
247        BC7 = 134,
248        ETC1 = 160,
249        ETC2 = 161,
250        ASTC = 162,
251        ETC1S = 163,
252        PVRTC = 164,
253        PVRTC2 = 165,
254        UASTC = 166,
255    }
256}
257
258pseudo_enum! {
259    NonZeroU8(u8) ColorPrimaries {
260        BT709 = 1,
261        BT601EBU = 2,
262        BT601SMPTE = 3,
263        BT2020 = 4,
264        CIEXYZ = 5,
265        ACES = 6,
266        ACESCC = 7,
267        NTSC1953 = 8,
268        PAL525 = 9,
269        DISPLAYP3 = 10,
270        AdobeRGB = 11,
271    }
272}
273
274pseudo_enum! {
275    NonZeroU8(u8) TransferFunction {
276        Linear = 1,
277        SRGB = 2,
278        ITU = 3,
279        NTSC = 4,
280        SLOG = 5,
281        SLOG2 = 6,
282        BT1886 = 7,
283        HLGOETF = 8,
284        HLGEOTF = 9,
285        PQEOTF = 10,
286        PQOETF = 11,
287        DCIP3 = 12,
288        PALOETF = 13,
289        PAL625EOTF = 14,
290        ST240 = 15,
291        ACESCC = 16,
292        ACESCCT = 17,
293        AdobeRGB = 18,
294    }
295}