PixelBuffer.h revision cf51a4199835e9604aa4c8b3854306f8fbabbf33
1cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy/* 2cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Copyright (C) 2013 The Android Open Source Project 3cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 4cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Licensed under the Apache License, Version 2.0 (the "License"); 5cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * you may not use this file except in compliance with the License. 6cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * You may obtain a copy of the License at 7cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 8cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * http://www.apache.org/licenses/LICENSE-2.0 9cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 10cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Unless required by applicable law or agreed to in writing, software 11cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * distributed under the License is distributed on an "AS IS" BASIS, 12cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * See the License for the specific language governing permissions and 14cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * limitations under the License. 15cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 16cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 17cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy#ifndef ANDROID_HWUI_PIXEL_BUFFER_H 18cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy#define ANDROID_HWUI_PIXEL_BUFFER_H 19cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 20cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy#include <GLES3/gl3.h> 21cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 22cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guynamespace android { 23cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guynamespace uirenderer { 24cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 25cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy/** 26cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Represents a pixel buffer. A pixel buffer will be backed either by a 27cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * PBO on OpenGL ES 3.0 and higher or by an array of uint8_t on other 28cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * versions. If the buffer is backed by a PBO it will of type 29cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * GL_PIXEL_UNPACK_BUFFER. 30cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 31cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * To read from or write into a PixelBuffer you must first map the 32cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * buffer using the map(AccessMode) method. This method returns a 33cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * pointer to the beginning of the buffer. 34cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 35cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Before the buffer can be used by the GPU, for instance to upload 36cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * a texture, you must first unmap the buffer. To do so, call the 37cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * unmap() method. 38cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 39cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Mapping and unmapping a PixelBuffer can have the side effect of 40cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * changing the currently active GL_PIXEL_UNPACK_BUFFER. It is 41cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * therefore recommended to call Caches::unbindPixelbuffer() after 42cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * using a PixelBuffer to upload to a texture. 43cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 44cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guyclass PixelBuffer { 45cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guypublic: 46cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy enum BufferType { 47cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kBufferType_Auto, 48cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kBufferType_CPU 49cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy }; 50cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 51cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy enum AccessMode { 52cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kAccessMode_None = 0, 53cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kAccessMode_Read = GL_MAP_READ_BIT, 54cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kAccessMode_Write = GL_MAP_WRITE_BIT, 55cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy kAccessMode_ReadWrite = GL_MAP_READ_BIT | GL_MAP_WRITE_BIT 56cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy }; 57cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 58cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 59cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Creates a new PixelBuffer object with the specified format and 60cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * dimensions. The buffer is immediately allocated. 61cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 62cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * The buffer type specifies how the buffer should be allocated. 63cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * By default this method will automatically choose whether to allocate 64cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * a CPU or GPU buffer. 65cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 66cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy static PixelBuffer* create(GLenum format, uint32_t width, uint32_t height, 67cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy BufferType type = kBufferType_Auto); 68cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 69cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy virtual ~PixelBuffer() { 70cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 71cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 72cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 73cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the format of this render buffer. 74cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 75cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy GLenum getFormat() const { 76cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return mFormat; 77cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 78cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 79cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 80cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Maps this before with the specified access mode. This method 81cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * returns a pointer to the region of memory where the buffer was 82cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * mapped. 83cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 84cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * If the buffer is already mapped when this method is invoked, 85cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * this method will return the previously mapped pointer. The 86cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * access mode can only be changed by calling unmap() first. 87cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 88cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * The specified access mode cannot be kAccessMode_None. 89cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 90cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy virtual uint8_t* map(AccessMode mode = kAccessMode_ReadWrite) = 0; 91cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 92cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 93cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Unmaps this buffer, if needed. After the buffer is unmapped, 94cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * the pointer previously returned by map() becomes invalid and 95cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * should not be used. After calling this method, getMappedPointer() 96cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * will always return NULL. 97cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 98cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy virtual void unmap() = 0; 99cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 100cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 101cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the current access mode for this buffer. If the buffer 102cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * is not mapped, this method returns kAccessMode_None. 103cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 104cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy AccessMode getAccessMode() const { 105cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return mAccessMode; 106cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 107cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 108cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 109cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the currently mapped pointer. Returns NULL if the buffer 110cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * is not mapped. 111cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 112cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy virtual uint8_t* getMappedPointer() const = 0; 113cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 114cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 115cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Upload the specified rectangle of this pixe buffer as a 116cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * GL_TEXTURE_2D texture. Calling this method will trigger 117cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * an unmap() if necessary. 118cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 119cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy virtual void upload(uint32_t x, uint32_t y, uint32_t width, uint32_t height, int offset) = 0; 120cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 121cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 122cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the width of the render buffer in pixels. 123cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 124cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy uint32_t getWidth() const { 125cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return mWidth; 126cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 127cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 128cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 129cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the height of the render buffer in pixels. 130cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 131cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy uint32_t getHeight() const { 132cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return mHeight; 133cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 134cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 135cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 136cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the size of this pixel buffer in bytes. 137cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 138cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy uint32_t getSize() const { 139cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return mWidth * mHeight * formatSize(mFormat); 140cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 141cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 142cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 143cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Returns the number of bytes per pixel in the specified format. 144cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * 145cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Supported formats: 146cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * GL_ALPHA 147cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * GL_RGBA 148cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 149cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy static uint32_t formatSize(GLenum format) { 150cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy switch (format) { 151cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy case GL_ALPHA: 152cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return 1; 153cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy case GL_RGBA: 154cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return 4; 155cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 156cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy return 0; 157cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 158cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 159cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guyprotected: 160cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy /** 161cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * Creates a new render buffer in the specified format and dimensions. 162cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy * The format must be GL_ALPHA or GL_RGBA. 163cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy */ 164cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy PixelBuffer(GLenum format, uint32_t width, uint32_t height): 165cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy mFormat(format), mWidth(width), mHeight(height), mAccessMode(kAccessMode_None) { 166cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy } 167cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 168cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy GLenum mFormat; 169cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 170cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy uint32_t mWidth; 171cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy uint32_t mHeight; 172cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 173cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy AccessMode mAccessMode; 174cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 175cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy}; // class PixelBuffer 176cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 177cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy}; // namespace uirenderer 178cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy}; // namespace android 179cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy 180cf51a4199835e9604aa4c8b3854306f8fbabbf33Romain Guy#endif // ANDROID_HWUI_PIXEL_BUFFER_H 181