PixelFormat.h revision edbf3b6af777b721cd2a1ef461947e51e88241e1
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/* 2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Copyright (C) 2005 The Android Open Source Project 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License. 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License. 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// Pixel formats used across the system. 20edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// These formats might not all be supported by all renderers, for instance 21edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// skia or SurfaceFlinger are not required to support all of these formats 22edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// (either as source or destination) 23edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 24edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// XXX: we should consolidate these formats and skia's 25edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 26edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef UI_PIXELFORMAT_H 27edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define UI_PIXELFORMAT_H 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <stdint.h> 30edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <sys/types.h> 31edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/Errors.h> 32edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <pixelflinger/format.h> 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectenum { 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // these constants need to match those 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // in graphics/PixelFormat.java & pixelflinger/format.h 40edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // 41edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_UNKNOWN = 0, 42edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_NONE = 0, 43edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 44edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // logical pixel formats used by the SurfaceFlinger ----------------------- 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_CUSTOM = -4, 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // Custom pixel-format described by a PixelFormatInfo structure 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 48edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_TRANSLUCENT = -3, 49edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // System chooses a format that supports translucency (many alpha bits) 50edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 51edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_TRANSPARENT = -2, 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // System chooses a format that supports transparency 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // (at least 1 alpha bit) 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_OPAQUE = -1, 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // System chooses an opaque format (no alpha bits required) 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // real pixel formats supported for rendering ----------------------------- 59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGBA_8888 = GGL_PIXEL_FORMAT_RGBA_8888, // 4x8-bit RGBA 61edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGBX_8888 = GGL_PIXEL_FORMAT_RGBX_8888, // 4x8-bit RGB0 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGB_888 = GGL_PIXEL_FORMAT_RGB_888, // 3x8-bit RGB 63edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGB_565 = GGL_PIXEL_FORMAT_RGB_565, // 16-bit RGB 64edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_BGRA_8888 = GGL_PIXEL_FORMAT_BGRA_8888, // 4x8-bit BGRA 65edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGBA_5551 = GGL_PIXEL_FORMAT_RGBA_5551, // 16-bit ARGB 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGBA_4444 = GGL_PIXEL_FORMAT_RGBA_4444, // 16-bit ARGB 67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_A_8 = GGL_PIXEL_FORMAT_A_8, // 8-bit A 68edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_L_8 = GGL_PIXEL_FORMAT_L_8, // 8-bit L (R=G=B=L) 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_LA_88 = GGL_PIXEL_FORMAT_LA_88, // 16-bit LA 70edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_RGB_332 = GGL_PIXEL_FORMAT_RGB_332, // 8-bit RGB 71edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 72edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_422_SP= GGL_PIXEL_FORMAT_YCbCr_422_SP, 73edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_420_SP= GGL_PIXEL_FORMAT_YCbCr_420_SP, 74edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_422_P = GGL_PIXEL_FORMAT_YCbCr_422_P, 75edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_420_P = GGL_PIXEL_FORMAT_YCbCr_420_P, 76edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_422_I = GGL_PIXEL_FORMAT_YCbCr_422_I, 77edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PIXEL_FORMAT_YCbCr_420_I = GGL_PIXEL_FORMAT_YCbCr_420_I, 78edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 79edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // New formats can be added if they're also defined in 80edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // pixelflinger/format.h 81edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 82edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 83edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projecttypedef int32_t PixelFormat; 84edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 85edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstruct PixelFormatInfo 86edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 87edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project enum { // components 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project ALPHA = 1, 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project RGB = 2, 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project RGBA = 3, 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project LUMINANCE = 4, 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project LUMINANCE_ALPHA = 5, 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Y_CB_CR_SP = 6, 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Y_CB_CR_P = 7, 95edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Y_CB_CR_I = 8, 96edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project }; 97edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 98edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline PixelFormatInfo() : version(sizeof(PixelFormatInfo)) { } 99edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t getScanlineSize(unsigned int width) const; 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t version; 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PixelFormat format; 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t bytesPerPixel; 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project size_t bitsPerPixel; 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t h_alpha; 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t l_alpha; 106edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t h_red; 107edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t l_red; 108edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t h_green; 109edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t l_green; 110edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t h_blue; 111edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t l_blue; 112edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t components; 113edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint8_t reserved0[3]; 114edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint32_t reserved1; 115edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 116edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 117edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// Consider caching the results of these functions are they're not 118edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// guaranteed to be fast. 119edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectssize_t bytesPerPixel(PixelFormat format); 120edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectssize_t bitsPerPixel(PixelFormat format); 121edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectstatus_t getPixelFormatInfo(PixelFormat format, PixelFormatInfo* info); 122edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 125edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // UI_PIXELFORMAT_H 126