Reland "[escher] Rename paper_renderer.cc to default_paper_renderer.cc"
This reverts commit 2b8d306d70c335b98befe99e778d7f3f5c5d535c.
Reason for revert: <INSERT REASONING HERE>
Original change's description:
> Revert "[escher] Rename paper_renderer.cc to default_paper_renderer.cc"
>
> This reverts commit b596570e78a27269f9dc51321e54a4f5a4e4dc88.
>
> Reason for revert: <INSERT REASONING HERE>
>
> Original change's description:
> > [escher] Rename paper_renderer.cc to default_paper_renderer.cc
> >
> > Upcoming CLs will refactor PaperRenderer to make a base-class
> > that is more amenable to testing. Moving this now will allow
> > Gerrit diffs to be more intelligible.
> >
> > Tests: CQ. There are no behavioral changes.
> >
> > Change-Id: I1d2e04509cdeecf18d63ec065754b4e0dec79064
>
> TBR=abarth@google.com,jjosh@google.com,jaeheon@google.com,cfontas@google.com
>
> Change-Id: I38af747eec601819130a581e9b8f92ff940dbdd6
> No-Presubmit: true
> No-Tree-Checks: true
> No-Try: true
TBR=abarth@google.com,jjosh@google.com,jaeheon@google.com,cfontas@google.com
Change-Id: Ib68f419773233807c0bb3594b010f32571e8871d
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
diff --git a/src/ui/lib/escher/BUILD.gn b/src/ui/lib/escher/BUILD.gn
index a0e4021..4946dba 100644
--- a/src/ui/lib/escher/BUILD.gn
+++ b/src/ui/lib/escher/BUILD.gn
@@ -298,6 +298,8 @@
"math/lerp.h",
"math/rotations.cc",
"math/rotations.h",
+ "paper/default_paper_renderer.cc",
+ "paper/default_paper_renderer.h",
"paper/paper_draw_call.h",
"paper/paper_draw_call_factory.cc",
"paper/paper_draw_call_factory.h",
@@ -315,7 +317,6 @@
"paper/paper_render_queue_context.cc",
"paper/paper_render_queue_context.h",
"paper/paper_render_queue_flags.h",
- "paper/paper_renderer.cc",
"paper/paper_renderer.h",
"paper/paper_renderer_config.h",
"paper/paper_scene.h",
diff --git a/src/ui/lib/escher/paper/paper_renderer.cc b/src/ui/lib/escher/paper/default_paper_renderer.cc
similarity index 99%
rename from src/ui/lib/escher/paper/paper_renderer.cc
rename to src/ui/lib/escher/paper/default_paper_renderer.cc
index 2c713c74..56e316d 100644
--- a/src/ui/lib/escher/paper/paper_renderer.cc
+++ b/src/ui/lib/escher/paper/default_paper_renderer.cc
@@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
-#include "src/ui/lib/escher/paper/paper_renderer.h"
+#include "src/ui/lib/escher/paper/default_paper_renderer.h"
#include <glm/gtc/matrix_access.hpp>
diff --git a/src/ui/lib/escher/paper/default_paper_renderer.h b/src/ui/lib/escher/paper/default_paper_renderer.h
new file mode 100644
index 0000000..9719e1b
--- /dev/null
+++ b/src/ui/lib/escher/paper/default_paper_renderer.h
@@ -0,0 +1,214 @@
+// Copyright 2018 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef SRC_UI_LIB_ESCHER_PAPER_DEFAULT_PAPER_RENDERER_H_
+#define SRC_UI_LIB_ESCHER_PAPER_DEFAULT_PAPER_RENDERER_H_
+
+#include "src/lib/fxl/logging.h"
+#include "src/ui/lib/escher/paper/paper_draw_call_factory.h"
+#include "src/ui/lib/escher/paper/paper_drawable.h"
+#include "src/ui/lib/escher/paper/paper_light.h"
+#include "src/ui/lib/escher/paper/paper_readme.h"
+#include "src/ui/lib/escher/paper/paper_render_queue.h"
+#include "src/ui/lib/escher/paper/paper_renderer_config.h"
+#include "src/ui/lib/escher/paper/paper_shape_cache.h"
+#include "src/ui/lib/escher/paper/paper_transform_stack.h"
+#include "src/ui/lib/escher/renderer/renderer.h"
+#include "src/ui/lib/escher/renderer/uniform_binding.h"
+
+namespace escher {
+
+// |PaperRenderer| provides a convenient and flexible interface for rendering
+// shapes in a 3D space, as required by Scenic. Clients achieve this primarily
+// by passing instances of |PaperDrawable| to the |Draw()| method, using either
+// pre-existing drawable types or their own subclasses. For convenience, other
+// drawing methods are provided, such as |DrawCircle()|.
+//
+// These draw methods are legal only between |BeginFrame()| and |EndFrame()|.
+// Respectively, these two methods prepare the renderer to render a frame, and
+// generate the Vulkan commands which actually perform the rendering.
+//
+// All other public methods must *not* be called between |BeginFrame()| and
+// |EndFrame()|. For example, |SetConfig()| can be used to choose a different
+// shadow algorithm; changing this during the frame would cause incompatibility
+// between the |PaperDrawCalls| previously and subsequently enqueued by the
+// |PaperDrawCallFactory|.
+//
+// Implementation details follow...
+//
+// |PaperRenderer| is responsible for coordinating its sub-components:
+// - |PaperDrawCallFactory|
+// - |PaperShapeCache|
+// - |PaperRenderQueue|
+// See their class comments for details.
+//
+// Clients call |SetConfig()| to specify the coordination policies that will be
+// used to render subsequent frames. When the config changes, the renderer
+// applies the appropriate changes to its sub-components.
+//
+// When |BeginFrame()| is called, each sub-component is made ready to render the
+// new frame. This depends on both the policies specified by |SetConfig()|, as
+// well as the |PaperScene|, |Camera|, and |output_image| parameters. Together,
+// these determine how:
+// - shader data is encoded in the draw calls built by |PaperDrawCallFactory|
+// - tessellated meshes are post-processed before they are cached/uploaded
+// ... and so forth.
+//
+// During |EndFrame()| the renderer first builds |RenderPassInfo| descriptions
+// of the Vulkan render passes necessary to render the scene. During each of
+// these render passes, the renderer directs the render-queue to iterate over
+// its draw calls and emit Vulkan commands into a |CommandBuffer|. This is
+// controlled by two parameters passed to the queue:
+// - |PaperRenderQueueFlags|, to control iteration over draw calls.
+// - |PaperRenderQueueContext|, used by draw calls to emit Vulkan commands.
+class PaperRenderer final : public Renderer {
+ public:
+ static PaperRendererPtr New(
+ EscherWeakPtr escher, const PaperRendererConfig& config = {
+ .shadow_type = PaperRendererShadowType::kNone});
+ ~PaperRenderer() override;
+
+ // Set configuration parameters which affect how the renderer will render
+ // subsequent frames.
+ void SetConfig(const PaperRendererConfig& config);
+ const PaperRendererConfig& config() const { return config_; }
+
+ // Does the renderer support the specified shadow type?
+ bool SupportsShadowType(PaperRendererShadowType shadow_type) const;
+
+ // Configures the renderer to render a frame into |output_image|. The
+ // renderer configures its sub-components to render the frame based on the
+ // |scene| and |camera| parameters, along with the configuration params
+ // previously set by |SetConfig()|.
+ //
+ // |PaperScene| describes aspects of the scene that affect the appearance of
+ // scene object (e.g. lighting parameters), but does not provide the list of
+ // scene objects to be rendered. To render the scene, clients should follow
+ // these steps:
+ // - |BeginFrame()|
+ // - |Draw()| each object in the scene.
+ // - |EndFrame()| emits the Vulkan commands that actually render the scene.
+ //
+ // Multiple cameras are supported, each rendering into its own viewport.
+ // However, the position of the first camera is the one used for depth-sorting
+ // the scene contents. For use-cases such as stereo rendering this is not a
+ // problem, however there can be problems with e.g. translucent objects if two
+ // cameras have dramatically different positions.
+ void BeginFrame(const FramePtr& frame, const PaperScenePtr& scene,
+ const std::vector<Camera>& cameras,
+ const escher::ImagePtr& output_image);
+
+ // See |BeginFrame()|. After telling the renderer to draw the scene content,
+ // |EndFrame()| emits commands into a Vulkan command buffer. Submitting this
+ // command buffer causes the scene to be rendered into |output_image|.
+ void EndFrame();
+
+ // The following methods may only be used between during a frame, i.e. between
+ // calls to |BeginFrame()| and |EndFrame()|.
+
+ // Return the transform stack, which affects the transform and clipping that
+ // is applied to subsequently-drawn |PaperDrawables|.
+ PaperTransformStack* transform_stack() {
+ FXL_DCHECK(frame_data_) << "transform_stack only accessible during frame.";
+ return &transform_stack_;
+ }
+
+ // Invokes DrawInScene() on the drawable object to generate and enqueue the
+ // draw-calls that be transformed into Vulkan commands during EndFrame().
+ void Draw(PaperDrawable* drawable, PaperDrawableFlags flags = {},
+ mat4* matrix = nullptr);
+
+ // Draw predefined shapes: circles, rectangles, and rounded-rectangles.
+ // Generates and enqueues draw-calls that will emit Vulkan commands during
+ // EndFrame().
+ void DrawCircle(float radius, const PaperMaterialPtr& material,
+ PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
+ void DrawRect(vec2 min, vec2 max, const PaperMaterialPtr& material,
+ PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
+ void DrawRoundedRect(const RoundedRectSpec& spec,
+ const PaperMaterialPtr& material,
+ PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
+
+ // Convenient way to draw "legacy" escher::Objects. Generates and enqueues
+ // draw-calls that will emit Vulkan commands during EndFrame().
+ void DrawLegacyObject(const Object& obj, PaperDrawableFlags flags = {});
+
+ private:
+ explicit PaperRenderer(EscherWeakPtr escher,
+ const PaperRendererConfig& config);
+ PaperRenderer(const PaperRenderer&) = delete;
+
+ // Store relevant info from cameras passed to BeginFrame().
+ struct CameraData {
+ UniformBinding binding;
+ vk::Rect2D rect;
+ vk::Viewport viewport;
+ uint32_t eye_index; // For PaperShaderPushConstants.
+ };
+
+ // Stores all per-frame data in one place.
+ struct FrameData {
+ FrameData(const FramePtr& frame, const PaperScenePtr& scene,
+ const ImagePtr& output_image,
+ std::pair<TexturePtr, TexturePtr> depth_and_msaa_textures,
+ const std::vector<Camera>& cameras);
+ ~FrameData();
+ FramePtr frame;
+ PaperScenePtr scene;
+ ImagePtr output_image;
+ TexturePtr depth_texture;
+ TexturePtr msaa_texture;
+
+ size_t num_lights;
+
+ std::vector<CameraData> cameras;
+
+ // UniformBindings returned by PaperDrawCallFactory::BeginFrame(). These
+ // contain camera and lighting parameters that are shared between draw
+ // calls. The contents are opaque to the PaperRenderer, who trusts that
+ // the PaperDrawCallFactory will generate DrawCalls that are compatible with
+ // these UniformBindings.
+ std::vector<UniformBinding> scene_uniform_bindings;
+
+ std::unique_ptr<BatchGpuUploader> gpu_uploader;
+ };
+
+ // Called in BeginFrame() to obtain suitable render targets.
+ // NOTE: call only once per frame.
+ std::pair<TexturePtr, TexturePtr> ObtainDepthAndMsaaTextures(
+ const FramePtr& frame, const ImageInfo& info);
+
+ // Called during EndFrame().
+ void BindSceneAndCameraUniforms(uint32_t camera_index);
+ void GenerateCommandsForNoShadows(uint32_t camera_index);
+ void GenerateCommandsForShadowVolumes(uint32_t camera_index);
+ static void InitRenderPassInfo(RenderPassInfo* render_pass_info,
+ ResourceRecycler* recycler,
+ const FrameData& frame_data,
+ uint32_t camera_index);
+
+ PaperRendererConfig config_;
+
+ PaperDrawCallFactory draw_call_factory_;
+ PaperRenderQueue render_queue_;
+ PaperShapeCache shape_cache_;
+ PaperTransformStack transform_stack_;
+
+ std::vector<TexturePtr> depth_buffers_;
+ std::vector<TexturePtr> msaa_buffers_;
+
+ std::unique_ptr<FrameData> frame_data_;
+
+ ShaderProgramPtr ambient_light_program_;
+ ShaderProgramPtr no_lighting_program_;
+ ShaderProgramPtr point_light_program_;
+ ShaderProgramPtr point_light_falloff_program_;
+ ShaderProgramPtr shadow_volume_geometry_program_;
+ ShaderProgramPtr shadow_volume_geometry_debug_program_;
+ ShaderProgramPtr shadow_volume_lighting_program_;
+};
+
+} // namespace escher
+
+#endif // SRC_UI_LIB_ESCHER_PAPER_DEFAULT_PAPER_RENDERER_H_
diff --git a/src/ui/lib/escher/paper/paper_renderer.h b/src/ui/lib/escher/paper/paper_renderer.h
index 324654b..1b9bcc2 100644
--- a/src/ui/lib/escher/paper/paper_renderer.h
+++ b/src/ui/lib/escher/paper/paper_renderer.h
@@ -5,210 +5,7 @@
#ifndef SRC_UI_LIB_ESCHER_PAPER_PAPER_RENDERER_H_
#define SRC_UI_LIB_ESCHER_PAPER_PAPER_RENDERER_H_
-#include "src/lib/fxl/logging.h"
-#include "src/ui/lib/escher/paper/paper_draw_call_factory.h"
-#include "src/ui/lib/escher/paper/paper_drawable.h"
-#include "src/ui/lib/escher/paper/paper_light.h"
-#include "src/ui/lib/escher/paper/paper_readme.h"
-#include "src/ui/lib/escher/paper/paper_render_queue.h"
-#include "src/ui/lib/escher/paper/paper_renderer_config.h"
-#include "src/ui/lib/escher/paper/paper_shape_cache.h"
-#include "src/ui/lib/escher/paper/paper_transform_stack.h"
-#include "src/ui/lib/escher/renderer/renderer.h"
-#include "src/ui/lib/escher/renderer/uniform_binding.h"
-
-namespace escher {
-
-// |PaperRenderer| provides a convenient and flexible interface for rendering
-// shapes in a 3D space, as required by Scenic. Clients achieve this primarily
-// by passing instances of |PaperDrawable| to the |Draw()| method, using either
-// pre-existing drawable types or their own subclasses. For convenience, other
-// drawing methods are provided, such as |DrawCircle()|.
-//
-// These draw methods are legal only between |BeginFrame()| and |EndFrame()|.
-// Respectively, these two methods prepare the renderer to render a frame, and
-// generate the Vulkan commands which actually perform the rendering.
-//
-// All other public methods must *not* be called between |BeginFrame()| and
-// |EndFrame()|. For example, |SetConfig()| can be used to choose a different
-// shadow algorithm; changing this during the frame would cause incompatibility
-// between the |PaperDrawCalls| previously and subsequently enqueued by the
-// |PaperDrawCallFactory|.
-//
-// Implementation details follow...
-//
-// |PaperRenderer| is responsible for coordinating its sub-components:
-// - |PaperDrawCallFactory|
-// - |PaperShapeCache|
-// - |PaperRenderQueue|
-// See their class comments for details.
-//
-// Clients call |SetConfig()| to specify the coordination policies that will be
-// used to render subsequent frames. When the config changes, the renderer
-// applies the appropriate changes to its sub-components.
-//
-// When |BeginFrame()| is called, each sub-component is made ready to render the
-// new frame. This depends on both the policies specified by |SetConfig()|, as
-// well as the |PaperScene|, |Camera|, and |output_image| parameters. Together,
-// these determine how:
-// - shader data is encoded in the draw calls built by |PaperDrawCallFactory|
-// - tessellated meshes are post-processed before they are cached/uploaded
-// ... and so forth.
-//
-// During |EndFrame()| the renderer first builds |RenderPassInfo| descriptions
-// of the Vulkan render passes necessary to render the scene. During each of
-// these render passes, the renderer directs the render-queue to iterate over
-// its draw calls and emit Vulkan commands into a |CommandBuffer|. This is
-// controlled by two parameters passed to the queue:
-// - |PaperRenderQueueFlags|, to control iteration over draw calls.
-// - |PaperRenderQueueContext|, used by draw calls to emit Vulkan commands.
-class PaperRenderer final : public Renderer {
- public:
- static PaperRendererPtr New(
- EscherWeakPtr escher, const PaperRendererConfig& config = {
- .shadow_type = PaperRendererShadowType::kNone});
- ~PaperRenderer() override;
-
- // Set configuration parameters which affect how the renderer will render
- // subsequent frames.
- void SetConfig(const PaperRendererConfig& config);
- const PaperRendererConfig& config() const { return config_; }
-
- // Does the renderer support the specified shadow type?
- bool SupportsShadowType(PaperRendererShadowType shadow_type) const;
-
- // Configures the renderer to render a frame into |output_image|. The
- // renderer configures its sub-components to render the frame based on the
- // |scene| and |camera| parameters, along with the configuration params
- // previously set by |SetConfig()|.
- //
- // |PaperScene| describes aspects of the scene that affect the appearance of
- // scene object (e.g. lighting parameters), but does not provide the list of
- // scene objects to be rendered. To render the scene, clients should follow
- // these steps:
- // - |BeginFrame()|
- // - |Draw()| each object in the scene.
- // - |EndFrame()| emits the Vulkan commands that actually render the scene.
- //
- // Multiple cameras are supported, each rendering into its own viewport.
- // However, the position of the first camera is the one used for depth-sorting
- // the scene contents. For use-cases such as stereo rendering this is not a
- // problem, however there can be problems with e.g. translucent objects if two
- // cameras have dramatically different positions.
- void BeginFrame(const FramePtr& frame, const PaperScenePtr& scene,
- const std::vector<Camera>& cameras,
- const escher::ImagePtr& output_image);
-
- // See |BeginFrame()|. After telling the renderer to draw the scene content,
- // |EndFrame()| emits commands into a Vulkan command buffer. Submitting this
- // command buffer causes the scene to be rendered into |output_image|.
- void EndFrame();
-
- // The following methods may only be used between during a frame, i.e. between
- // calls to |BeginFrame()| and |EndFrame()|.
-
- // Return the transform stack, which affects the transform and clipping that
- // is applied to subsequently-drawn |PaperDrawables|.
- PaperTransformStack* transform_stack() {
- FXL_DCHECK(frame_data_) << "transform_stack only accessible during frame.";
- return &transform_stack_;
- }
-
- // Invokes DrawInScene() on the drawable object to generate and enqueue the
- // draw-calls that be transformed into Vulkan commands during EndFrame().
- void Draw(PaperDrawable* drawable, PaperDrawableFlags flags = {},
- mat4* matrix = nullptr);
-
- // Draw predefined shapes: circles, rectangles, and rounded-rectangles.
- // Generates and enqueues draw-calls that will emit Vulkan commands during
- // EndFrame().
- void DrawCircle(float radius, const PaperMaterialPtr& material,
- PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
- void DrawRect(vec2 min, vec2 max, const PaperMaterialPtr& material,
- PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
- void DrawRoundedRect(const RoundedRectSpec& spec,
- const PaperMaterialPtr& material,
- PaperDrawableFlags flags = {}, mat4* matrix = nullptr);
-
- // Convenient way to draw "legacy" escher::Objects. Generates and enqueues
- // draw-calls that will emit Vulkan commands during EndFrame().
- void DrawLegacyObject(const Object& obj, PaperDrawableFlags flags = {});
-
- private:
- explicit PaperRenderer(EscherWeakPtr escher,
- const PaperRendererConfig& config);
- PaperRenderer(const PaperRenderer&) = delete;
-
- // Store relevant info from cameras passed to BeginFrame().
- struct CameraData {
- UniformBinding binding;
- vk::Rect2D rect;
- vk::Viewport viewport;
- uint32_t eye_index; // For PaperShaderPushConstants.
- };
-
- // Stores all per-frame data in one place.
- struct FrameData {
- FrameData(const FramePtr& frame, const PaperScenePtr& scene,
- const ImagePtr& output_image,
- std::pair<TexturePtr, TexturePtr> depth_and_msaa_textures,
- const std::vector<Camera>& cameras);
- ~FrameData();
- FramePtr frame;
- PaperScenePtr scene;
- ImagePtr output_image;
- TexturePtr depth_texture;
- TexturePtr msaa_texture;
-
- size_t num_lights;
-
- std::vector<CameraData> cameras;
-
- // UniformBindings returned by PaperDrawCallFactory::BeginFrame(). These
- // contain camera and lighting parameters that are shared between draw
- // calls. The contents are opaque to the PaperRenderer, who trusts that
- // the PaperDrawCallFactory will generate DrawCalls that are compatible with
- // these UniformBindings.
- std::vector<UniformBinding> scene_uniform_bindings;
-
- std::unique_ptr<BatchGpuUploader> gpu_uploader;
- };
-
- // Called in BeginFrame() to obtain suitable render targets.
- // NOTE: call only once per frame.
- std::pair<TexturePtr, TexturePtr> ObtainDepthAndMsaaTextures(
- const FramePtr& frame, const ImageInfo& info);
-
- // Called during EndFrame().
- void BindSceneAndCameraUniforms(uint32_t camera_index);
- void GenerateCommandsForNoShadows(uint32_t camera_index);
- void GenerateCommandsForShadowVolumes(uint32_t camera_index);
- static void InitRenderPassInfo(RenderPassInfo* render_pass_info,
- ResourceRecycler* recycler,
- const FrameData& frame_data,
- uint32_t camera_index);
-
- PaperRendererConfig config_;
-
- PaperDrawCallFactory draw_call_factory_;
- PaperRenderQueue render_queue_;
- PaperShapeCache shape_cache_;
- PaperTransformStack transform_stack_;
-
- std::vector<TexturePtr> depth_buffers_;
- std::vector<TexturePtr> msaa_buffers_;
-
- std::unique_ptr<FrameData> frame_data_;
-
- ShaderProgramPtr ambient_light_program_;
- ShaderProgramPtr no_lighting_program_;
- ShaderProgramPtr point_light_program_;
- ShaderProgramPtr point_light_falloff_program_;
- ShaderProgramPtr shadow_volume_geometry_program_;
- ShaderProgramPtr shadow_volume_geometry_debug_program_;
- ShaderProgramPtr shadow_volume_lighting_program_;
-};
-
-} // namespace escher
+// Temporary placeholder to preserve git history.
+#include "src/ui/lib/escher/paper/default_paper_renderer.h"
#endif // SRC_UI_LIB_ESCHER_PAPER_PAPER_RENDERER_H_
