All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
graphicsEncoder.h
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 HGI_GRAPHICS_ENCODER_H
25 #define HGI_GRAPHICS_ENCODER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/gf/vec4i.h"
29 #include "pxr/imaging/hgi/api.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
43 {
44 public:
45  HGI_API
47 
48  HGI_API
49  virtual ~HgiGraphicsEncoder();
50 
52  HGI_API
53  virtual void EndEncoding() = 0;
54 
56  HGI_API
57  virtual void SetViewport(GfVec4i const& vp) = 0;
58 
60  HGI_API
61  virtual void PushDebugGroup(const char* label) = 0;
62 
64  HGI_API
65  virtual void PopDebugGroup() = 0;
66 
67 private:
68  HgiGraphicsEncoder & operator=(const HgiGraphicsEncoder&) = delete;
69  HgiGraphicsEncoder(const HgiGraphicsEncoder&) = delete;
70 };
71 
72 
73 
74 PXR_NAMESPACE_CLOSE_SCOPE
75 
76 #endif
Basic type for a vector of 4 int components.
Definition: vec4i.h:61
virtual HGI_API void PopDebugGroup()=0
Pop the lastest debug marker off encoder.
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker onto the encoder.
A graphics API independent abstraction of graphics commands.
virtual HGI_API void SetViewport(GfVec4i const &vp)=0
Set viewport [left, BOTTOM, width, height] - OpenGL coords.
virtual HGI_API void EndEncoding()=0
Finish recording of commands. No further commands can be recorded.