HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
graphicsCmdsDesc.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_HGI_GRAPHICS_CMDS_DESC_H
25 #define PXR_IMAGING_HGI_GRAPHICS_CMDS_DESC_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
31 #include <vector>
32 
34 
35 
36 /// \struct HgiGraphicsCmdsDesc
37 ///
38 /// Describes the properties to begin a HgiGraphicsCmds.
39 ///
40 /// <ul>
41 /// <li>colorAttachmentDescs:
42 /// Describes each of the color attachments.</li>
43 /// <li>depthAttachmentDesc:
44 /// Describes the depth attachment (optional)</li>
45 /// <li>colorTextures:
46 /// The color attachment render targets.</li>
47 /// <li>colorResolveTextures:
48 /// The (optional) textures that the color textures will be resolved into
49 /// at the end of the render pass.</li>
50 /// <li>depthTexture:
51 /// The depth attachment render target (optional)</li>
52 /// <li>depthResolveTexture:
53 /// The (optional) texture that the depth texture will be resolved into
54 /// at the end of the render pass.</li>
55 /// <li>width:
56 /// Render target width (in pixels)</li>
57 /// <li>height:
58 /// Render target height (in pixels)</li>
59 /// </ul>
60 ///
62 {
66  , colorTextures()
68  , depthTexture()
70  {}
71 
72  inline bool HasAttachments() const {
73  return !colorAttachmentDescs.empty() || depthTexture;
74  }
75 
78 
81 
84 };
85 
86 HGI_API
87 bool operator==(
88  const HgiGraphicsCmdsDesc& lhs,
89  const HgiGraphicsCmdsDesc& rhs);
90 
91 HGI_API
92 bool operator!=(
93  const HgiGraphicsCmdsDesc& lhs,
94  const HgiGraphicsCmdsDesc& rhs);
95 
96 HGI_API
97 std::ostream& operator<<(
98  std::ostream& out,
99  const HgiGraphicsCmdsDesc& desc);
100 
101 
103 
104 #endif
HgiAttachmentDescVector colorAttachmentDescs
std::vector< HgiAttachmentDesc > HgiAttachmentDescVector
int HgiHandle< class HgiTexture > HgiTextureHandle
HgiAttachmentDesc depthAttachmentDesc
std::vector< HgiTextureHandle > HgiTextureHandleVector
Definition: texture.h:207
HgiTextureHandle depthTexture
HgiTextureHandleVector colorResolveTextures
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:570
bool HasAttachments() const
#define HGI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HgiTextureHandleVector colorTextures
HgiTextureHandle depthResolveTexture
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:556
HGI_API std::ostream & operator<<(std::ostream &out, const HgiGraphicsCmdsDesc &desc)