HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
imageShaderRenderPass.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HD_ST_IMAGE_SHADER_RENDER_PASS_H
25 #define PXR_IMAGING_HD_ST_IMAGE_SHADER_RENDER_PASS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
31 
32 #include <memory>
33 
35 
37  std::shared_ptr<class HdStResourceRegistry>;
38 
40  std::shared_ptr<class HdSt_ImageShaderRenderPass>;
42  std::shared_ptr<class HdStResourceRegistry>;
43 
44 class Hgi;
45 
46 /// \class HdSt_ImageShaderRenderPass
47 ///
48 /// A single, full-screen triangle render pass.
49 /// The task that creates this RenderPass should set a RenderPassShader on the
50 /// RenderPassState. The RenderPassShader is your full-screen post-effect.
51 /// The benefit of using RenderPassShader is that it participates in codegen.
52 /// This means your full-screen shader can use buffers created by other tasks.
53 ///
55 public:
56  HDST_API
58  HdRprimCollection const &collection);
59 
60  HDST_API
62 
63 protected:
64  virtual void _Prepare(TfTokenVector const &renderTags) override;
65 
66  virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
67  TfTokenVector const &renderTags) override;
68 
69  virtual void _MarkCollectionDirty() override;
70 
71 private:
72  // Setup a BAR for a single triangle
73  void _SetupVertexPrimvarBAR(HdStResourceRegistrySharedPtr const&);
74 
75  // We re-use the immediateBatch to draw the full-screen triangle.
76  HdRprimSharedData _sharedData;
77  HdStDrawItem _drawItem;
78  HdStDrawItemInstance _drawItemInstance;
79  HdSt_DrawBatchSharedPtr _immediateBatch;
80  Hgi* _hgi;
81 };
82 
84 
85 #endif
std::shared_ptr< class HdRenderPassState > HdRenderPassStateSharedPtr
Definition: engine.h:42
GLuint index
Definition: glew.h:1814
virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags) override
virtual void _MarkCollectionDirty() override
Optional API: let derived classes mark their collection tracking as dirty.
std::shared_ptr< class HdSt_ImageShaderRenderPass > HdSt_ImageShaderRenderPassSharedPtr
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
HDST_API HdSt_ImageShaderRenderPass(HdRenderIndex *index, HdRprimCollection const &collection)
Definition: hgi.h:106
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual HDST_API ~HdSt_ImageShaderRenderPass()
std::shared_ptr< class HdStResourceRegistry > HdStResourceRegistrySharedPtr
Definition: commandBuffer.h:47
virtual void _Prepare(TfTokenVector const &renderTags) override
Optional API: let derived classes prepare data.
std::shared_ptr< class HdSt_DrawBatch > HdSt_DrawBatchSharedPtr
Definition: commandBuffer.h:49