• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2005 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 //
18 
19 // Pixel formats used across the system.
20 // These formats might not all be supported by all renderers, for instance
21 // skia or SurfaceFlinger are not required to support all of these formats
22 // (either as source or destination)
23 
24 
25 #ifndef UI_PIXELFORMAT_H
26 #define UI_PIXELFORMAT_H
27 
28 #include <stdint.h>
29 #include <sys/types.h>
30 #include <utils/Errors.h>
31 #include <hardware/hardware.h>
32 
33 namespace android {
34 
35 enum {
36     //
37     // these constants need to match those
38     // in graphics/PixelFormat.java & pixelflinger/format.h
39     //
40     PIXEL_FORMAT_UNKNOWN    =   0,
41     PIXEL_FORMAT_NONE       =   0,
42 
43     // logical pixel formats used by the SurfaceFlinger -----------------------
44     PIXEL_FORMAT_CUSTOM         = -4,
45         // Custom pixel-format described by a PixelFormatInfo structure
46 
47     PIXEL_FORMAT_TRANSLUCENT    = -3,
48         // System chooses a format that supports translucency (many alpha bits)
49 
50     PIXEL_FORMAT_TRANSPARENT    = -2,
51         // System chooses a format that supports transparency
52         // (at least 1 alpha bit)
53 
54     PIXEL_FORMAT_OPAQUE         = -1,
55         // System chooses an opaque format (no alpha bits required)
56 
57     // real pixel formats supported for rendering -----------------------------
58 
59     PIXEL_FORMAT_RGBA_8888   = HAL_PIXEL_FORMAT_RGBA_8888,  // 4x8-bit RGBA
60     PIXEL_FORMAT_RGBX_8888   = HAL_PIXEL_FORMAT_RGBX_8888,  // 4x8-bit RGB0
61     PIXEL_FORMAT_RGB_888     = HAL_PIXEL_FORMAT_RGB_888,    // 3x8-bit RGB
62     PIXEL_FORMAT_RGB_565     = HAL_PIXEL_FORMAT_RGB_565,    // 16-bit RGB
63     PIXEL_FORMAT_BGRA_8888   = HAL_PIXEL_FORMAT_BGRA_8888,  // 4x8-bit BGRA
64     PIXEL_FORMAT_RGBA_5551   = HAL_PIXEL_FORMAT_RGBA_5551,  // 16-bit ARGB
65     PIXEL_FORMAT_RGBA_4444   = HAL_PIXEL_FORMAT_RGBA_4444,  // 16-bit ARGB
66     PIXEL_FORMAT_A_8         = 8,                           // 8-bit A
67 };
68 
69 typedef int32_t PixelFormat;
70 
71 struct PixelFormatInfo {
72     enum {
73         INDEX_ALPHA   = 0,
74         INDEX_RED     = 1,
75         INDEX_GREEN   = 2,
76         INDEX_BLUE    = 3
77     };
78 
79     enum { // components
80         ALPHA   = 1,
81         RGB     = 2,
82         RGBA    = 3,
83         L       = 4,
84         LA      = 5,
85         OTHER   = 0xFF
86     };
87 
88     struct szinfo {
89         uint8_t h;
90         uint8_t l;
91     };
92 
PixelFormatInfoPixelFormatInfo93     inline PixelFormatInfo() : version(sizeof(PixelFormatInfo)) { }
94     size_t getScanlineSize(unsigned int width) const;
getSizePixelFormatInfo95     size_t getSize(size_t ci) const {
96         return (ci <= 3) ? (cinfo[ci].h - cinfo[ci].l) : 0;
97     }
98     size_t      version;
99     PixelFormat format;
100     size_t      bytesPerPixel;
101     size_t      bitsPerPixel;
102     union {
103         szinfo      cinfo[4];
104         struct {
105             uint8_t     h_alpha;
106             uint8_t     l_alpha;
107             uint8_t     h_red;
108             uint8_t     l_red;
109             uint8_t     h_green;
110             uint8_t     l_green;
111             uint8_t     h_blue;
112             uint8_t     l_blue;
113         };
114     };
115     uint8_t     components;
116     uint8_t     reserved0[3];
117     uint32_t    reserved1;
118 };
119 
120 // Consider caching the results of these functions are they're not
121 // guaranteed to be fast.
122 ssize_t     bytesPerPixel(PixelFormat format);
123 ssize_t     bitsPerPixel(PixelFormat format);
124 status_t    getPixelFormatInfo(PixelFormat format, PixelFormatInfo* info);
125 
126 }; // namespace android
127 
128 #endif // UI_PIXELFORMAT_H
129