1 // Copyright 2010 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CC_OUTPUT_GL_RENDERER_H_
6 #define CC_OUTPUT_GL_RENDERER_H_
8 #include "base/cancelable_callback.h"
9 #include "cc/base/cc_export.h"
10 #include "cc/base/scoped_ptr_vector.h"
11 #include "cc/output/direct_renderer.h"
12 #include "cc/output/gl_renderer_draw_cache.h"
13 #include "cc/output/program_binding.h"
14 #include "cc/output/renderer.h"
15 #include "cc/quads/checkerboard_draw_quad.h"
16 #include "cc/quads/debug_border_draw_quad.h"
17 #include "cc/quads/io_surface_draw_quad.h"
18 #include "cc/quads/render_pass_draw_quad.h"
19 #include "cc/quads/solid_color_draw_quad.h"
20 #include "cc/quads/tile_draw_quad.h"
21 #include "cc/quads/yuv_video_draw_quad.h"
22 #include "ui/gfx/quad_f.h"
26 namespace WebKit
{ class WebGraphicsContext3D
; }
30 class GLRendererShaderTest
;
32 class PictureDrawQuad
;
34 class StreamVideoDrawQuad
;
35 class TextureDrawQuad
;
36 class TextureMailboxDeleter
;
37 class GeometryBinding
;
38 class ScopedEnsureFramebufferAllocation
;
40 // Class that handles drawing of composited render layers using GL.
41 class CC_EXPORT GLRenderer
: public DirectRenderer
{
43 static scoped_ptr
<GLRenderer
> Create(
44 RendererClient
* client
,
45 const LayerTreeSettings
* settings
,
46 OutputSurface
* output_surface
,
47 ResourceProvider
* resource_provider
,
48 TextureMailboxDeleter
* texture_mailbox_deleter
,
49 int highp_threshold_min
,
50 bool use_skia_gpu_backend
);
52 virtual ~GLRenderer();
54 virtual const RendererCapabilities
& Capabilities() const OVERRIDE
;
56 WebKit::WebGraphicsContext3D
* Context();
58 virtual void ViewportChanged() OVERRIDE
;
60 // Waits for rendering to finish.
61 virtual void Finish() OVERRIDE
;
63 virtual void DoNoOp() OVERRIDE
;
64 virtual void SwapBuffers() OVERRIDE
;
66 virtual void GetFramebufferPixels(void* pixels
, gfx::Rect rect
) OVERRIDE
;
68 virtual bool IsContextLost() OVERRIDE
;
70 virtual void SetVisible(bool visible
) OVERRIDE
;
72 virtual void SendManagedMemoryStats(size_t bytes_visible
,
73 size_t bytes_visible_and_nearby
,
74 size_t bytes_allocated
) OVERRIDE
;
76 virtual void SetDiscardBackBufferWhenNotVisible(bool discard
) OVERRIDE
;
78 static void DebugGLCall(WebKit::WebGraphicsContext3D
* context
,
83 bool CanUseSkiaGPUBackend() const;
86 GLRenderer(RendererClient
* client
,
87 const LayerTreeSettings
* settings
,
88 OutputSurface
* output_surface
,
89 ResourceProvider
* resource_provider
,
90 TextureMailboxDeleter
* texture_mailbox_deleter
,
91 int highp_threshold_min
);
93 bool IsBackbufferDiscarded() const { return is_backbuffer_discarded_
; }
95 void InitializeGrContext();
97 const gfx::QuadF
& SharedGeometryQuad() const { return shared_geometry_quad_
; }
98 const GeometryBinding
* SharedGeometry() const {
99 return shared_geometry_
.get();
102 void GetFramebufferPixelsAsync(gfx::Rect rect
,
103 scoped_ptr
<CopyOutputRequest
> request
);
104 void GetFramebufferTexture(unsigned texture_id
,
105 ResourceFormat texture_format
,
106 gfx::Rect device_rect
);
107 void ReleaseRenderPassTextures();
109 void SetStencilEnabled(bool enabled
);
110 bool stencil_enabled() const { return stencil_shadow_
; }
111 void SetBlendEnabled(bool enabled
);
112 bool blend_enabled() const { return blend_shadow_
; }
114 virtual void BindFramebufferToOutputSurface(DrawingFrame
* frame
) OVERRIDE
;
115 virtual bool BindFramebufferToTexture(DrawingFrame
* frame
,
116 const ScopedResource
* resource
,
117 gfx::Rect target_rect
) OVERRIDE
;
118 virtual void SetDrawViewport(gfx::Rect window_space_viewport
) OVERRIDE
;
119 virtual void SetScissorTestRect(gfx::Rect scissor_rect
) OVERRIDE
;
120 virtual void DiscardPixels(bool has_external_stencil_test
,
121 bool draw_rect_covers_full_surface
) OVERRIDE
;
122 virtual void ClearFramebuffer(DrawingFrame
* frame
,
123 bool has_external_stencil_test
) OVERRIDE
;
124 virtual void DoDrawQuad(DrawingFrame
* frame
, const class DrawQuad
*) OVERRIDE
;
125 virtual void BeginDrawingFrame(DrawingFrame
* frame
) OVERRIDE
;
126 virtual void FinishDrawingFrame(DrawingFrame
* frame
) OVERRIDE
;
127 virtual bool FlippedFramebuffer() const OVERRIDE
;
128 virtual void EnsureScissorTestEnabled() OVERRIDE
;
129 virtual void EnsureScissorTestDisabled() OVERRIDE
;
130 virtual void CopyCurrentRenderPassToBitmap(
132 scoped_ptr
<CopyOutputRequest
> request
) OVERRIDE
;
133 virtual void FinishDrawingQuadList() OVERRIDE
;
135 // Check if quad needs antialiasing and if so, inflate the quad and
136 // fill edge array for fragment shader. local_quad is set to
137 // inflated quad if antialiasing is required, otherwise it is left
138 // unchanged. edge array is filled with inflated quad's edge data
139 // if antialiasing is required, otherwise it is left unchanged.
140 // Returns true if quad requires antialiasing and false otherwise.
141 static bool SetupQuadForAntialiasing(const gfx::Transform
& device_transform
,
142 const DrawQuad
* quad
,
143 gfx::QuadF
* local_quad
,
147 friend class GLRendererShaderPixelTest
;
148 friend class GLRendererShaderTest
;
150 static void ToGLMatrix(float* gl_matrix
, const gfx::Transform
& transform
);
152 void DrawCheckerboardQuad(const DrawingFrame
* frame
,
153 const CheckerboardDrawQuad
* quad
);
154 void DrawDebugBorderQuad(const DrawingFrame
* frame
,
155 const DebugBorderDrawQuad
* quad
);
156 scoped_ptr
<ScopedResource
> DrawBackgroundFilters(
158 const RenderPassDrawQuad
* quad
,
159 const gfx::Transform
& contents_device_transform
,
160 const gfx::Transform
& contents_device_transformInverse
);
161 void DrawRenderPassQuad(DrawingFrame
* frame
, const RenderPassDrawQuad
* quad
);
162 void DrawSolidColorQuad(const DrawingFrame
* frame
,
163 const SolidColorDrawQuad
* quad
);
164 void DrawStreamVideoQuad(const DrawingFrame
* frame
,
165 const StreamVideoDrawQuad
* quad
);
166 void EnqueueTextureQuad(const DrawingFrame
* frame
,
167 const TextureDrawQuad
* quad
);
168 void FlushTextureQuadCache();
169 void DrawIOSurfaceQuad(const DrawingFrame
* frame
,
170 const IOSurfaceDrawQuad
* quad
);
171 void DrawTileQuad(const DrawingFrame
* frame
, const TileDrawQuad
* quad
);
172 void DrawContentQuad(const DrawingFrame
* frame
,
173 const ContentDrawQuadBase
* quad
,
174 ResourceProvider::ResourceId resource_id
);
175 void DrawYUVVideoQuad(const DrawingFrame
* frame
,
176 const YUVVideoDrawQuad
* quad
);
177 void DrawPictureQuad(const DrawingFrame
* frame
,
178 const PictureDrawQuad
* quad
);
179 void DrawPictureQuadDirectToBackbuffer(const DrawingFrame
* frame
,
180 const PictureDrawQuad
* quad
);
182 void SetShaderOpacity(float opacity
, int alpha_location
);
183 void SetShaderQuadF(const gfx::QuadF
& quad
, int quad_location
);
184 void DrawQuadGeometry(const DrawingFrame
* frame
,
185 const gfx::Transform
& draw_transform
,
186 const gfx::RectF
& quad_rect
,
187 int matrix_location
);
188 void SetUseProgram(unsigned program
);
190 void CopyTextureToFramebuffer(const DrawingFrame
* frame
,
193 const gfx::Transform
& draw_matrix
,
194 bool flip_vertically
);
196 bool UseScopedTexture(DrawingFrame
* frame
,
197 const ScopedResource
* resource
,
198 gfx::Rect viewport_rect
);
200 bool MakeContextCurrent();
202 bool InitializeSharedObjects();
203 void CleanupSharedObjects();
205 typedef base::Callback
<void(scoped_ptr
<CopyOutputRequest
> copy_request
,
207 AsyncGetFramebufferPixelsCleanupCallback
;
208 void DoGetFramebufferPixels(
210 gfx::Rect window_rect
,
211 const AsyncGetFramebufferPixelsCleanupCallback
& cleanup_callback
);
212 void FinishedReadback(
213 const AsyncGetFramebufferPixelsCleanupCallback
& cleanup_callback
,
214 unsigned source_buffer
,
216 uint8_t* dest_pixels
,
218 void PassOnSkBitmap(scoped_ptr
<SkBitmap
> bitmap
,
219 scoped_ptr
<SkAutoLockPixels
> lock
,
220 scoped_ptr
<CopyOutputRequest
> request
,
223 void ReinitializeGrCanvas();
224 void ReinitializeGLState();
226 virtual void DiscardBackbuffer() OVERRIDE
;
227 virtual void EnsureBackbuffer() OVERRIDE
;
228 void EnforceMemoryPolicy();
230 RendererCapabilities capabilities_
;
232 unsigned offscreen_framebuffer_id_
;
234 scoped_ptr
<GeometryBinding
> shared_geometry_
;
235 gfx::QuadF shared_geometry_quad_
;
237 // This block of bindings defines all of the programs used by the compositor
238 // itself. Add any new programs here to GLRendererShaderTest.
240 // Tiled layer shaders.
241 typedef ProgramBinding
<VertexShaderTile
, FragmentShaderRGBATexAlpha
>
243 typedef ProgramBinding
<VertexShaderTileAA
, FragmentShaderRGBATexClampAlphaAA
>
245 typedef ProgramBinding
<VertexShaderTileAA
,
246 FragmentShaderRGBATexClampSwizzleAlphaAA
>
247 TileProgramSwizzleAA
;
248 typedef ProgramBinding
<VertexShaderTile
, FragmentShaderRGBATexOpaque
>
250 typedef ProgramBinding
<VertexShaderTile
, FragmentShaderRGBATexSwizzleAlpha
>
252 typedef ProgramBinding
<VertexShaderTile
, FragmentShaderRGBATexSwizzleOpaque
>
253 TileProgramSwizzleOpaque
;
254 typedef ProgramBinding
<VertexShaderPosTex
, FragmentShaderCheckerboard
>
255 TileCheckerboardProgram
;
258 typedef ProgramBinding
<VertexShaderPosTexTransform
,
259 FragmentShaderRGBATexVaryingAlpha
> TextureProgram
;
260 typedef ProgramBinding
<VertexShaderPosTexTransform
,
261 FragmentShaderRGBATexPremultiplyAlpha
>
262 NonPremultipliedTextureProgram
;
263 typedef ProgramBinding
<VertexShaderPosTexTransform
,
264 FragmentShaderTexBackgroundVaryingAlpha
>
265 TextureBackgroundProgram
;
266 typedef ProgramBinding
<VertexShaderPosTexTransform
,
267 FragmentShaderTexBackgroundPremultiplyAlpha
>
268 NonPremultipliedTextureBackgroundProgram
;
269 typedef ProgramBinding
<VertexShaderPosTexTransform
,
270 FragmentShaderRGBATexRectVaryingAlpha
>
271 TextureIOSurfaceProgram
;
273 // Render surface shaders.
274 typedef ProgramBinding
<VertexShaderPosTexTransform
,
275 FragmentShaderRGBATexAlpha
> RenderPassProgram
;
276 typedef ProgramBinding
<VertexShaderPosTexTransform
,
277 FragmentShaderRGBATexAlphaMask
> RenderPassMaskProgram
;
278 typedef ProgramBinding
<VertexShaderQuadTexTransformAA
,
279 FragmentShaderRGBATexAlphaAA
> RenderPassProgramAA
;
280 typedef ProgramBinding
<VertexShaderQuadTexTransformAA
,
281 FragmentShaderRGBATexAlphaMaskAA
>
282 RenderPassMaskProgramAA
;
283 typedef ProgramBinding
<VertexShaderPosTexTransform
,
284 FragmentShaderRGBATexColorMatrixAlpha
>
285 RenderPassColorMatrixProgram
;
286 typedef ProgramBinding
<VertexShaderQuadTexTransformAA
,
287 FragmentShaderRGBATexAlphaMaskColorMatrixAA
>
288 RenderPassMaskColorMatrixProgramAA
;
289 typedef ProgramBinding
<VertexShaderQuadTexTransformAA
,
290 FragmentShaderRGBATexAlphaColorMatrixAA
>
291 RenderPassColorMatrixProgramAA
;
292 typedef ProgramBinding
<VertexShaderPosTexTransform
,
293 FragmentShaderRGBATexAlphaMaskColorMatrix
>
294 RenderPassMaskColorMatrixProgram
;
297 typedef ProgramBinding
<VertexShaderVideoTransform
,
298 FragmentShaderOESImageExternal
>
299 VideoStreamTextureProgram
;
300 typedef ProgramBinding
<VertexShaderPosTexYUVStretch
, FragmentShaderYUVVideo
>
302 typedef ProgramBinding
<VertexShaderPosTexYUVStretch
, FragmentShaderYUVAVideo
>
305 // Special purpose / effects shaders.
306 typedef ProgramBinding
<VertexShaderPos
, FragmentShaderColor
>
308 typedef ProgramBinding
<VertexShaderQuad
, FragmentShaderColor
>
310 typedef ProgramBinding
<VertexShaderQuadAA
, FragmentShaderColorAA
>
313 const TileProgram
* GetTileProgram(TexCoordPrecision precision
);
314 const TileProgramOpaque
* GetTileProgramOpaque(TexCoordPrecision precision
);
315 const TileProgramAA
* GetTileProgramAA(TexCoordPrecision precision
);
316 const TileProgramSwizzle
* GetTileProgramSwizzle(TexCoordPrecision precision
);
317 const TileProgramSwizzleOpaque
* GetTileProgramSwizzleOpaque(
318 TexCoordPrecision precision
);
319 const TileProgramSwizzleAA
* GetTileProgramSwizzleAA(
320 TexCoordPrecision precision
);
321 const TileCheckerboardProgram
* GetTileCheckerboardProgram();
323 const RenderPassProgram
* GetRenderPassProgram(
324 TexCoordPrecision precision
);
325 const RenderPassProgramAA
* GetRenderPassProgramAA(
326 TexCoordPrecision precision
);
327 const RenderPassMaskProgram
* GetRenderPassMaskProgram(
328 TexCoordPrecision precision
);
329 const RenderPassMaskProgramAA
* GetRenderPassMaskProgramAA(
330 TexCoordPrecision precision
);
331 const RenderPassColorMatrixProgram
* GetRenderPassColorMatrixProgram(
332 TexCoordPrecision precision
);
333 const RenderPassColorMatrixProgramAA
* GetRenderPassColorMatrixProgramAA(
334 TexCoordPrecision precision
);
335 const RenderPassMaskColorMatrixProgram
* GetRenderPassMaskColorMatrixProgram(
336 TexCoordPrecision precision
);
337 const RenderPassMaskColorMatrixProgramAA
*
338 GetRenderPassMaskColorMatrixProgramAA(TexCoordPrecision precision
);
340 const TextureProgram
* GetTextureProgram(
341 TexCoordPrecision precision
);
342 const NonPremultipliedTextureProgram
* GetNonPremultipliedTextureProgram(
343 TexCoordPrecision precision
);
344 const TextureBackgroundProgram
* GetTextureBackgroundProgram(
345 TexCoordPrecision precision
);
346 const NonPremultipliedTextureBackgroundProgram
*
347 GetNonPremultipliedTextureBackgroundProgram(TexCoordPrecision precision
);
348 const TextureIOSurfaceProgram
* GetTextureIOSurfaceProgram(
349 TexCoordPrecision precision
);
351 const VideoYUVProgram
* GetVideoYUVProgram(
352 TexCoordPrecision precision
);
353 const VideoYUVAProgram
* GetVideoYUVAProgram(
354 TexCoordPrecision precision
);
355 const VideoStreamTextureProgram
* GetVideoStreamTextureProgram(
356 TexCoordPrecision precision
);
358 const DebugBorderProgram
* GetDebugBorderProgram();
359 const SolidColorProgram
* GetSolidColorProgram();
360 const SolidColorProgramAA
* GetSolidColorProgramAA();
362 scoped_ptr
<TileProgram
> tile_program_
;
363 scoped_ptr
<TileProgramOpaque
> tile_program_opaque_
;
364 scoped_ptr
<TileProgramAA
> tile_program_aa_
;
365 scoped_ptr
<TileProgramSwizzle
> tile_program_swizzle_
;
366 scoped_ptr
<TileProgramSwizzleOpaque
> tile_program_swizzle_opaque_
;
367 scoped_ptr
<TileProgramSwizzleAA
> tile_program_swizzle_aa_
;
368 scoped_ptr
<TileCheckerboardProgram
> tile_checkerboard_program_
;
370 scoped_ptr
<TileProgram
> tile_program_highp_
;
371 scoped_ptr
<TileProgramOpaque
> tile_program_opaque_highp_
;
372 scoped_ptr
<TileProgramAA
> tile_program_aa_highp_
;
373 scoped_ptr
<TileProgramSwizzle
> tile_program_swizzle_highp_
;
374 scoped_ptr
<TileProgramSwizzleOpaque
> tile_program_swizzle_opaque_highp_
;
375 scoped_ptr
<TileProgramSwizzleAA
> tile_program_swizzle_aa_highp_
;
377 scoped_ptr
<TextureProgram
> texture_program_
;
378 scoped_ptr
<NonPremultipliedTextureProgram
> nonpremultiplied_texture_program_
;
379 scoped_ptr
<TextureBackgroundProgram
> texture_background_program_
;
380 scoped_ptr
<NonPremultipliedTextureBackgroundProgram
>
381 nonpremultiplied_texture_background_program_
;
382 scoped_ptr
<TextureIOSurfaceProgram
> texture_io_surface_program_
;
384 scoped_ptr
<TextureProgram
> texture_program_highp_
;
385 scoped_ptr
<NonPremultipliedTextureProgram
>
386 nonpremultiplied_texture_program_highp_
;
387 scoped_ptr
<TextureBackgroundProgram
> texture_background_program_highp_
;
388 scoped_ptr
<NonPremultipliedTextureBackgroundProgram
>
389 nonpremultiplied_texture_background_program_highp_
;
390 scoped_ptr
<TextureIOSurfaceProgram
> texture_io_surface_program_highp_
;
392 scoped_ptr
<RenderPassProgram
> render_pass_program_
;
393 scoped_ptr
<RenderPassProgramAA
> render_pass_program_aa_
;
394 scoped_ptr
<RenderPassMaskProgram
> render_pass_mask_program_
;
395 scoped_ptr
<RenderPassMaskProgramAA
> render_pass_mask_program_aa_
;
396 scoped_ptr
<RenderPassColorMatrixProgram
> render_pass_color_matrix_program_
;
397 scoped_ptr
<RenderPassColorMatrixProgramAA
>
398 render_pass_color_matrix_program_aa_
;
399 scoped_ptr
<RenderPassMaskColorMatrixProgram
>
400 render_pass_mask_color_matrix_program_
;
401 scoped_ptr
<RenderPassMaskColorMatrixProgramAA
>
402 render_pass_mask_color_matrix_program_aa_
;
404 scoped_ptr
<RenderPassProgram
> render_pass_program_highp_
;
405 scoped_ptr
<RenderPassProgramAA
> render_pass_program_aa_highp_
;
406 scoped_ptr
<RenderPassMaskProgram
> render_pass_mask_program_highp_
;
407 scoped_ptr
<RenderPassMaskProgramAA
> render_pass_mask_program_aa_highp_
;
408 scoped_ptr
<RenderPassColorMatrixProgram
>
409 render_pass_color_matrix_program_highp_
;
410 scoped_ptr
<RenderPassColorMatrixProgramAA
>
411 render_pass_color_matrix_program_aa_highp_
;
412 scoped_ptr
<RenderPassMaskColorMatrixProgram
>
413 render_pass_mask_color_matrix_program_highp_
;
414 scoped_ptr
<RenderPassMaskColorMatrixProgramAA
>
415 render_pass_mask_color_matrix_program_aa_highp_
;
417 scoped_ptr
<VideoYUVProgram
> video_yuv_program_
;
418 scoped_ptr
<VideoYUVAProgram
> video_yuva_program_
;
419 scoped_ptr
<VideoStreamTextureProgram
> video_stream_texture_program_
;
421 scoped_ptr
<VideoYUVProgram
> video_yuv_program_highp_
;
422 scoped_ptr
<VideoYUVAProgram
> video_yuva_program_highp_
;
423 scoped_ptr
<VideoStreamTextureProgram
> video_stream_texture_program_highp_
;
425 scoped_ptr
<DebugBorderProgram
> debug_border_program_
;
426 scoped_ptr
<SolidColorProgram
> solid_color_program_
;
427 scoped_ptr
<SolidColorProgramAA
> solid_color_program_aa_
;
429 WebKit::WebGraphicsContext3D
* context_
;
431 skia::RefPtr
<GrContext
> gr_context_
;
432 skia::RefPtr
<SkCanvas
> sk_canvas_
;
434 TextureMailboxDeleter
* texture_mailbox_deleter_
;
436 gfx::Rect swap_buffer_rect_
;
437 gfx::Rect scissor_rect_
;
439 bool is_backbuffer_discarded_
;
440 bool discard_backbuffer_when_not_visible_
;
441 bool is_using_bind_uniform_
;
443 bool is_scissor_enabled_
;
444 bool stencil_shadow_
;
446 unsigned program_shadow_
;
447 TexturedQuadDrawCache draw_cache_
;
448 int highp_threshold_min_
;
449 int highp_threshold_cache_
;
451 struct PendingAsyncReadPixels
;
452 ScopedPtrVector
<PendingAsyncReadPixels
> pending_async_read_pixels_
;
454 scoped_ptr
<ResourceProvider::ScopedWriteLockGL
> current_framebuffer_lock_
;
456 scoped_refptr
<ResourceProvider::Fence
> last_swap_fence_
;
458 SkBitmap on_demand_tile_raster_bitmap_
;
459 ResourceProvider::ResourceId on_demand_tile_raster_resource_id_
;
461 DISALLOW_COPY_AND_ASSIGN(GLRenderer
);
464 // Setting DEBUG_GL_CALLS to 1 will call glGetError() after almost every GL
465 // call made by the compositor. Useful for debugging rendering issues but
466 // will significantly degrade performance.
467 #define DEBUG_GL_CALLS 0
469 #if DEBUG_GL_CALLS && !defined(NDEBUG)
470 #define GLC(context, x) \
471 (x, GLRenderer::DebugGLCall(&* context, #x, __FILE__, __LINE__))
473 #define GLC(context, x) (x)
478 #endif // CC_OUTPUT_GL_RENDERER_H_