]> git.tdb.fi Git - libs/gl.git/blob - source/core/pixelformat.h
Combine the external_image functions in Texture::Loader
[libs/gl.git] / source / core / pixelformat.h
1 #ifndef MSP_GL_PIXELFORMAT_H_
2 #define MSP_GL_PIXELFORMAT_H_
3
4 #include <msp/graphics/image.h>
5 #include <msp/strings/lexicalcast.h>
6 #include "datatype.h"
7
8 namespace Msp {
9 namespace GL {
10
11 /**
12 Identifies the components of a pixel, without type information.
13
14 The values are bitfields laid as follows:
15
16 _grs dccc
17  │││ │  └╴Number of components
18  │││ └───╴Depth flag
19  ││└─────╴Stencil flag
20  │└──────╴Reverse order flag
21  └───────╴Grayscale flag
22
23 This information is presented for internal documentation purposes only; it is
24 inadvisable for applications to rely on it.
25 */
26 enum PixelComponents
27 {
28         RED = 0x01,
29         RG = 0x02,
30         RGB = 0x03,
31         RGBA = 0x04,
32         DEPTH_COMPONENT = 0x09,
33         STENCIL_INDEX = 0x11,
34         BGR = 0x23,
35         BGRA = 0x24,
36         LUMINANCE = 0x41,
37         LUMINANCE_ALPHA = 0x42
38 };
39
40 /**
41 Identifies a pixel format, with components and type.
42
43 The values are bitfields laid as follows:
44
45 tnfg ssss cccc cccc
46 ││││    │         └╴Components (see PixelComponents)
47 ││││    └──────────╴Size of one component (bytes)
48 │││└───────────────╴Signed flag
49 ││└────────────────╴Floating-point flag
50 │└─────────────────╴Normalized flag
51 └──────────────────╴sRGB flag
52
53 This information is presented for internal documentation purposes only; it is
54 inadvisable for applications to rely on it.
55 */
56 enum PixelFormat
57 {
58         NO_PIXELFORMAT = 0,
59         R8 = 0x4100|RED,
60         R16F = 0x3200|RED,
61         R32F = 0x3400|RED,
62         RG8 = 0x4100|RG,
63         RG16F = 0x3200|RG,
64         RG32F = 0x3400|RG,
65         RGB8 = 0x4100|RGB,
66         RGB16F = 0x3200|RGB,
67         RGB32F = 0x3400|RGB,
68         RGBA8 = 0x4100|RGBA,
69         RGBA16F = 0x3200|RGBA,
70         RGBA32F = 0x3400|RGBA,
71         SRGB8 = 0xC100|RGB,
72         SRGB8_ALPHA8 = 0xC100|RGBA,
73         BGR8 = 0x4100|BGR,
74         BGRA8 = 0x4100|BGRA,
75         SBGR8 = 0xC100|BGR,
76         SBGR8_ALPHA8 = 0xC100|BGRA,
77         LUMINANCE8 = 0x4100|LUMINANCE,
78         LUMINANCE8_ALPHA8 = 0x4100|LUMINANCE_ALPHA,
79         DEPTH_COMPONENT16 = 0x4200|DEPTH_COMPONENT,
80         DEPTH_COMPONENT24 = 0x4300|DEPTH_COMPONENT,
81         DEPTH_COMPONENT32 = 0x4400|DEPTH_COMPONENT,
82         DEPTH_COMPONENT32F = 0x3400|DEPTH_COMPONENT,
83         STENCIL_INDEX8 = 0x0100|STENCIL_INDEX
84 };
85
86 void operator>>(const LexicalConverter &, PixelComponents &);
87 void operator>>(const LexicalConverter &, PixelFormat &);
88
89 PixelComponents components_from_graphics(Graphics::PixelFormat);
90 PixelFormat pixelformat_from_image(const Graphics::Image &, bool = false);
91
92 PixelFormat make_pixelformat(PixelComponents, DataType, bool = false);
93 inline PixelComponents get_components(PixelFormat f) { return static_cast<PixelComponents>(f&0xFF); }
94 inline unsigned get_component_count(PixelComponents c) { return c&7; }
95 inline unsigned get_component_count(PixelFormat f) { return get_component_count(get_components(f)); }
96 inline DataType get_component_type(PixelFormat f) { return static_cast<DataType>((f&0xF00)>>8 | (f&0x3000)>>4); }
97 inline unsigned get_component_size(PixelFormat f) { return get_type_size(get_component_type(f)); }
98 inline bool is_srgb(PixelFormat f) { return f&0x8000; }
99 inline unsigned get_pixel_size(PixelFormat f) { return get_component_count(f)*get_type_size(get_component_type(f)); }
100
101 void require_pixelformat(PixelFormat);
102
103 } // namespace GL
104 } // namespace Msp
105
106 #include "pixelformat_backend.h"
107
108 #endif