HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
attachmentDesc.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 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_ATTACHMENT_DESC_H
25 #define PXR_IMAGING_HGI_ATTACHMENT_DESC_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
29 #include "pxr/imaging/hgi/enums.h"
30 #include "pxr/imaging/hgi/types.h"
31 #include "pxr/base/gf/vec4f.h"
32 #include <vector>
33 
35 
36 
37 /// \struct HgiAttachmentDesc
38 ///
39 /// Describes the properties of a framebuffer attachment.
40 ///
41 /// <ul>
42 /// <li>texture:
43 /// The texture used as render target attachment.</li>
44 /// <li>loadOp:
45 /// The operation to perform on the attachment pixel data prior to rendering.</li>
46 /// <li>storeOp:
47 /// The operation to perform on the attachment pixel data after rendering.</li>
48 /// <li>clearValue:
49 /// The value to clear the attachment with (r,g,b,a) or (depth,stencil,x,x)</li>
50 /// <li>blendEnabled:
51 /// Determines if a blend operation should be applied to the attachment.</li>
52 /// <li> ***BlendFactor:
53 /// The blend factors for source and destination.</li>
54 /// <li> ***BlendOp:
55 /// The blending operation.</li>
56 ///
58 {
63  , clearValue(0)
64  , blendEnabled(false)
71  {}
72 
84 };
85 
86 using HgiAttachmentDescVector = std::vector<HgiAttachmentDesc>;
87 
88 HGI_API
89 bool operator==(
90  const HgiAttachmentDesc& lhs,
91  const HgiAttachmentDesc& rhs);
92 
93 HGI_API
94 bool operator!=(
95  const HgiAttachmentDesc& lhs,
96  const HgiAttachmentDesc& rhs);
97 
98 HGI_API
99 std::ostream& operator<<(
100  std::ostream& out,
102 
103 
105 
106 #endif
HgiAttachmentLoadOp
Definition: enums.h:189
std::vector< HgiAttachmentDesc > HgiAttachmentDescVector
HgiBlendFactor dstAlphaBlendFactor
HgiBlendOp alphaBlendOp
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: glew.h:1254
GLenum attachment
Definition: glew.h:2361
HgiBlendFactor srcColorBlendFactor
HgiAttachmentStoreOp
Definition: enums.h:209
HgiBlendFactor
Definition: enums.h:420
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:563
HgiBlendOp
Definition: enums.h:405
HGI_API std::ostream & operator<<(std::ostream &out, const HgiAttachmentDesc &attachment)
HgiAttachmentStoreOp storeOp
Definition: vec4f.h:63
#define HGI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
HgiBlendFactor dstColorBlendFactor
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HgiFormat
Definition: types.h:42
HgiBlendOp colorBlendOp
HgiAttachmentLoadOp loadOp
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:549
HgiBlendFactor srcAlphaBlendFactor