gfx/skia/trunk/include/gpu/gl/GrGLConfig.h@deefc01c0e14 (annotated)
gfx/skia/trunk/include/gpu/gl/GrGLConfig.h
Thu, 15 Jan 2015 21:03:48 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 15 Jan 2015 21:03:48 +0100
- branch
- TOR_BUG_9701
- changeset 11
- deefc01c0e14
- permissions
- -rw-r--r--
Integrate friendly tips from Tor colleagues to make (or not) 4.5 alpha 3;
This includes removal of overloaded (but unused) methods, and addition of
a overlooked call to DataStruct::SetData(nsISupports, uint32_t, bool.)
| michael@0 | 1 | |
| michael@0 | 2 | /* |
| michael@0 | 3 | * Copyright 2011 Google Inc. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Use of this source code is governed by a BSD-style license that can be |
| michael@0 | 6 | * found in the LICENSE file. |
| michael@0 | 7 | */ |
| michael@0 | 8 | |
| michael@0 | 9 | |
| michael@0 | 10 | |
| michael@0 | 11 | #ifndef GrGLConfig_DEFINED |
| michael@0 | 12 | #define GrGLConfig_DEFINED |
| michael@0 | 13 | |
| michael@0 | 14 | #include "GrTypes.h" |
| michael@0 | 15 | |
| michael@0 | 16 | /** |
| michael@0 | 17 | * Optional GL config file. |
| michael@0 | 18 | */ |
| michael@0 | 19 | #ifdef GR_GL_CUSTOM_SETUP_HEADER |
| michael@0 | 20 | #include GR_GL_CUSTOM_SETUP_HEADER |
| michael@0 | 21 | #endif |
| michael@0 | 22 | |
| michael@0 | 23 | #if !defined(GR_GL_FUNCTION_TYPE) |
| michael@0 | 24 | #define GR_GL_FUNCTION_TYPE |
| michael@0 | 25 | #endif |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * The following are optional defines that can be enabled at the compiler |
| michael@0 | 29 | * command line, in a IDE project, in a GrUserConfig.h file, or in a GL custom |
| michael@0 | 30 | * file (if one is in use). If a GR_GL_CUSTOM_SETUP_HEADER is used they can |
| michael@0 | 31 | * also be placed there. |
| michael@0 | 32 | * |
| michael@0 | 33 | * GR_GL_LOG_CALLS: if 1 Gr can print every GL call using GrPrintf. Defaults to |
| michael@0 | 34 | * 0. Logging can be enabled and disabled at runtime using a debugger via to |
| michael@0 | 35 | * global gLogCallsGL. The initial value of gLogCallsGL is controlled by |
| michael@0 | 36 | * GR_GL_LOG_CALLS_START. |
| michael@0 | 37 | * |
| michael@0 | 38 | * GR_GL_LOG_CALLS_START: controls the initial value of gLogCallsGL when |
| michael@0 | 39 | * GR_GL_LOG_CALLS is 1. Defaults to 0. |
| michael@0 | 40 | * |
| michael@0 | 41 | * GR_GL_CHECK_ERROR: if enabled Gr can do a glGetError() after every GL call. |
| michael@0 | 42 | * Defaults to 1 if SK_DEBUG is set, otherwise 0. When GR_GL_CHECK_ERROR is 1 |
| michael@0 | 43 | * this can be toggled in a debugger using the gCheckErrorGL global. The initial |
| michael@0 | 44 | * value of gCheckErrorGL is controlled by by GR_GL_CHECK_ERROR_START. |
| michael@0 | 45 | * |
| michael@0 | 46 | * GR_GL_CHECK_ERROR_START: controls the initial value of gCheckErrorGL |
| michael@0 | 47 | * when GR_GL_CHECK_ERROR is 1. Defaults to 1. |
| michael@0 | 48 | * |
| michael@0 | 49 | * GR_GL_NO_CONSTANT_ATTRIBUTES: if this evaluates to true then the GL backend |
| michael@0 | 50 | * will use uniforms instead of attributes in all cases when there is not |
| michael@0 | 51 | * per-vertex data. This is important when the underlying GL implementation |
| michael@0 | 52 | * doesn't actually support immediate style attribute values (e.g. when |
| michael@0 | 53 | * the GL stream is converted to DX as in ANGLE on Chrome). Defaults to 0. |
| michael@0 | 54 | * |
| michael@0 | 55 | * GR_GL_USE_BUFFER_DATA_NULL_HINT: When specifing new data for a vertex/index |
| michael@0 | 56 | * buffer that replaces old data Ganesh can give a hint to the driver that the |
| michael@0 | 57 | * previous data will not be used in future draws like this: |
| michael@0 | 58 | * glBufferData(GL_..._BUFFER, size, NULL, usage); //<--hint, NULL means |
| michael@0 | 59 | * glBufferSubData(GL_..._BUFFER, 0, lessThanSize, data) // old data can't be |
| michael@0 | 60 | * // used again. |
| michael@0 | 61 | * However, this can be an unoptimization on some platforms, esp. Chrome. |
| michael@0 | 62 | * Chrome's cmd buffer will create a new allocation and memset the whole thing |
| michael@0 | 63 | * to zero (for security reasons). Defaults to 1 (enabled). |
| michael@0 | 64 | * |
| michael@0 | 65 | * GR_GL_PER_GL_FUNC_CALLBACK: When set to 1 the GrGLInterface object provides |
| michael@0 | 66 | * a function pointer that is called just before every gl function. The ptr must |
| michael@0 | 67 | * be valid (i.e. there is no NULL check). However, by default the callback will |
| michael@0 | 68 | * be set to a function that does nothing. The signature of the function is: |
| michael@0 | 69 | * void function(const GrGLInterface*) |
| michael@0 | 70 | * It is not extern "C". |
| michael@0 | 71 | * The GrGLInterface field fCallback specifies the function ptr and there is an |
| michael@0 | 72 | * additional field fCallbackData of type intptr_t for client data. |
| michael@0 | 73 | * |
| michael@0 | 74 | * GR_GL_RGBA_8888_PIXEL_OPS_SLOW: Set this to 1 if it is known that performing |
| michael@0 | 75 | * glReadPixels / glTex(Sub)Image with format=GL_RGBA, type=GL_UNISIGNED_BYTE is |
| michael@0 | 76 | * significantly slower than format=GL_BGRA, type=GL_UNISIGNED_BYTE. |
| michael@0 | 77 | * |
| michael@0 | 78 | * GR_GL_FULL_READPIXELS_FASTER_THAN_PARTIAL: Set this to 1 if calling |
| michael@0 | 79 | * glReadPixels to read the entire framebuffer is faster than calling it with |
| michael@0 | 80 | * the same sized rectangle but with a framebuffer bound that is larger than |
| michael@0 | 81 | * the rectangle read. |
| michael@0 | 82 | * |
| michael@0 | 83 | * GR_GL_CHECK_ALLOC_WITH_GET_ERROR: If set to 1 this will then glTexImage, |
| michael@0 | 84 | * glBufferData, glRenderbufferStorage, etc will be checked for errors. This |
| michael@0 | 85 | * amounts to ensuring the error is GL_NO_ERROR, calling the allocating |
| michael@0 | 86 | * function, and then checking that the error is still GL_NO_ERROR. When the |
| michael@0 | 87 | * value is 0 we will assume no error was generated without checking. |
| michael@0 | 88 | * |
| michael@0 | 89 | * GR_GL_CHECK_FBO_STATUS_ONCE_PER_FORMAT: We will normally check the FBO status |
| michael@0 | 90 | * every time we bind a texture or renderbuffer to an FBO. However, in some |
| michael@0 | 91 | * environments CheckFrameBufferStatus is very expensive. If this is set we will |
| michael@0 | 92 | * check the first time we use a color format or a combination of color / |
| michael@0 | 93 | * stencil formats as attachments. If the FBO is complete we will assume |
| michael@0 | 94 | * subsequent attachments with the same formats are complete as well. |
| michael@0 | 95 | * |
| michael@0 | 96 | * GR_GL_MUST_USE_VBO: Indicates that all vertices and indices must be rendered |
| michael@0 | 97 | * from VBOs. Chromium's command buffer doesn't allow glVertexAttribArray with |
| michael@0 | 98 | * ARARY_BUFFER 0 bound or glDrawElements with ELEMENT_ARRAY_BUFFER 0 bound. |
| michael@0 | 99 | * |
| michael@0 | 100 | * GR_GL_USE_NEW_SHADER_SOURCE_SIGNATURE is for compatibility with the new version |
| michael@0 | 101 | * of the OpenGLES2.0 headers from Khronos. glShaderSource now takes a const char * const *, |
| michael@0 | 102 | * instead of a const char |
| michael@0 | 103 | */ |
| michael@0 | 104 | |
| michael@0 | 105 | #if !defined(GR_GL_LOG_CALLS) |
| michael@0 | 106 | #ifdef SK_DEBUG |
| michael@0 | 107 | #define GR_GL_LOG_CALLS 1 |
| michael@0 | 108 | #else |
| michael@0 | 109 | #define GR_GL_LOG_CALLS 0 |
| michael@0 | 110 | #endif |
| michael@0 | 111 | #endif |
| michael@0 | 112 | |
| michael@0 | 113 | #if !defined(GR_GL_LOG_CALLS_START) |
| michael@0 | 114 | #define GR_GL_LOG_CALLS_START 0 |
| michael@0 | 115 | #endif |
| michael@0 | 116 | |
| michael@0 | 117 | #if !defined(GR_GL_CHECK_ERROR) |
| michael@0 | 118 | #ifdef SK_DEBUG |
| michael@0 | 119 | #define GR_GL_CHECK_ERROR 1 |
| michael@0 | 120 | #else |
| michael@0 | 121 | #define GR_GL_CHECK_ERROR 0 |
| michael@0 | 122 | #endif |
| michael@0 | 123 | #endif |
| michael@0 | 124 | |
| michael@0 | 125 | #if !defined(GR_GL_CHECK_ERROR_START) |
| michael@0 | 126 | #define GR_GL_CHECK_ERROR_START 1 |
| michael@0 | 127 | #endif |
| michael@0 | 128 | |
| michael@0 | 129 | #if !defined(GR_GL_NO_CONSTANT_ATTRIBUTES) |
| michael@0 | 130 | #define GR_GL_NO_CONSTANT_ATTRIBUTES 0 |
| michael@0 | 131 | #endif |
| michael@0 | 132 | |
| michael@0 | 133 | #if !defined(GR_GL_USE_BUFFER_DATA_NULL_HINT) |
| michael@0 | 134 | #define GR_GL_USE_BUFFER_DATA_NULL_HINT 1 |
| michael@0 | 135 | #endif |
| michael@0 | 136 | |
| michael@0 | 137 | #if !defined(GR_GL_PER_GL_FUNC_CALLBACK) |
| michael@0 | 138 | #define GR_GL_PER_GL_FUNC_CALLBACK 0 |
| michael@0 | 139 | #endif |
| michael@0 | 140 | |
| michael@0 | 141 | #if !defined(GR_GL_RGBA_8888_PIXEL_OPS_SLOW) |
| michael@0 | 142 | #define GR_GL_RGBA_8888_PIXEL_OPS_SLOW 0 |
| michael@0 | 143 | #endif |
| michael@0 | 144 | |
| michael@0 | 145 | #if !defined(GR_GL_FULL_READPIXELS_FASTER_THAN_PARTIAL) |
| michael@0 | 146 | #define GR_GL_FULL_READPIXELS_FASTER_THAN_PARTIAL 0 |
| michael@0 | 147 | #endif |
| michael@0 | 148 | |
| michael@0 | 149 | #if !defined(GR_GL_CHECK_ALLOC_WITH_GET_ERROR) |
| michael@0 | 150 | #define GR_GL_CHECK_ALLOC_WITH_GET_ERROR 1 |
| michael@0 | 151 | #endif |
| michael@0 | 152 | |
| michael@0 | 153 | #if !defined(GR_GL_CHECK_FBO_STATUS_ONCE_PER_FORMAT) |
| michael@0 | 154 | #define GR_GL_CHECK_FBO_STATUS_ONCE_PER_FORMAT 0 |
| michael@0 | 155 | #endif |
| michael@0 | 156 | |
| michael@0 | 157 | #if !defined(GR_GL_MUST_USE_VBO) |
| michael@0 | 158 | #define GR_GL_MUST_USE_VBO 0 |
| michael@0 | 159 | #endif |
| michael@0 | 160 | |
| michael@0 | 161 | #if !defined(GR_GL_USE_NEW_SHADER_SOURCE_SIGNATURE) |
| michael@0 | 162 | #define GR_GL_USE_NEW_SHADER_SOURCE_SIGNATURE 0 |
| michael@0 | 163 | #endif |
| michael@0 | 164 | |
| michael@0 | 165 | /** |
| michael@0 | 166 | * There is a strange bug that occurs on Macs with NVIDIA GPUs. We don't |
| michael@0 | 167 | * fully understand it. When (element) array buffers are continually |
| michael@0 | 168 | * respecified using glBufferData performance can fall off of a cliff. The |
| michael@0 | 169 | * driver winds up performing many DMA mapping / unmappings and chews up ~50% of |
| michael@0 | 170 | * the core. However, it has been observed that occaisonally respecifiying the |
| michael@0 | 171 | * buffer using glBufferData and then writing data using glBufferSubData |
| michael@0 | 172 | * prevents the bad behavior. |
| michael@0 | 173 | * |
| michael@0 | 174 | * There is a lot of uncertainty around this issue. In Chrome backgrounding |
| michael@0 | 175 | * the tab somehow initiates this behavior and we don't know what the connection |
| michael@0 | 176 | * is. Another observation is that Chrome's cmd buffer server will actually |
| michael@0 | 177 | * create a buffer full of zeros when it sees a NULL data param (for security |
| michael@0 | 178 | * reasons). If this is disabled and NULL is actually passed all the way to the |
| michael@0 | 179 | * driver then the workaround doesn't help. |
| michael@0 | 180 | * |
| michael@0 | 181 | * The issue is tracked at: |
| michael@0 | 182 | * http://code.google.com/p/chromium/issues/detail?id=114865 |
| michael@0 | 183 | * |
| michael@0 | 184 | * When the workaround is enabled we will use the glBufferData / glBufferSubData |
| michael@0 | 185 | * trick every 128 array buffer uploads. |
| michael@0 | 186 | * |
| michael@0 | 187 | * Hopefully we will understand this better and have a cleaner fix or get a |
| michael@0 | 188 | * OS/driver level fix. |
| michael@0 | 189 | */ |
| michael@0 | 190 | #define GR_GL_MAC_BUFFER_OBJECT_PERFOMANCE_WORKAROUND \ |
| michael@0 | 191 | (defined(SK_BUILD_FOR_MAC) && \ |
| michael@0 | 192 | !GR_GL_USE_BUFFER_DATA_NULL_HINT) |
| michael@0 | 193 | |
| michael@0 | 194 | #endif |
