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>format:
43 /// The format of the attachment.
44 /// Must match what is set in HgiTextureDesc.</li>
45 /// <li>usage:
46 /// Describes how the texture is intended to be used.
47 /// Must match what is set in HgiTextureDesc.</li>
48 /// <li>loadOp:
49 /// The operation to perform on the attachment pixel data prior to rendering.</li>
50 /// <li>storeOp:
51 /// The operation to perform on the attachment pixel data after rendering.</li>
52 /// <li>clearValue:
53 /// The value to clear the attachment with (r,g,b,a) or (depth,stencil,x,x)</li>
54 /// <li>colorMask:
55 /// Whether to permit or restrict writing to component channels.</li>
56 /// <li>blendEnabled:
57 /// Determines if a blend operation should be applied to the attachment.</li>
58 /// <li> ***BlendFactor:
59 /// The blend factors for source and destination.</li>
60 /// <li> ***BlendOp:
61 /// The blending operation.</li>
62 /// <li> blendConstantColor:
63 /// The constant color for blend operations.</li>
64 ///
66 {
69  , usage(0)
72  , clearValue(0)
75  , blendEnabled(false)
82  , blendConstantColor(0.0f, 0.0f, 0.0f, 0.0f)
83  {}
84 
99 };
100 
101 using HgiAttachmentDescVector = std::vector<HgiAttachmentDesc>;
102 
103 HGI_API
104 bool operator==(
105  const HgiAttachmentDesc& lhs,
106  const HgiAttachmentDesc& rhs);
107 
108 HGI_API
109 bool operator!=(
110  const HgiAttachmentDesc& lhs,
111  const HgiAttachmentDesc& rhs);
112 
113 HGI_API
114 std::ostream& operator<<(
115  std::ostream& out,
117 
118 
120 
121 #endif
HgiAttachmentLoadOp
Definition: enums.h:266
std::vector< HgiAttachmentDesc > HgiAttachmentDescVector
HgiBlendFactor dstAlphaBlendFactor
HgiBlendOp alphaBlendOp
HgiTextureUsage usage
HgiFormat
Definition: types.h:45
HgiBlendFactor srcColorBlendFactor
HgiBits HgiTextureUsage
Definition: enums.h:161
HgiAttachmentStoreOp
Definition: enums.h:286
HgiBlendFactor
Definition: enums.h:488
GfVec4f blendConstantColor
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:570
HgiBlendOp
Definition: enums.h:473
HGI_API std::ostream & operator<<(std::ostream &out, const HgiAttachmentDesc &attachment)
GLenum attachment
Definition: glcorearb.h:1291
HgiAttachmentStoreOp storeOp
Definition: vec4f.h:63
GLint GLint GLsizei GLint GLenum format
Definition: glcorearb.h:108
#define HGI_API
Definition: api.h:40
HgiColorMask colorMask
GLsizeiptr const void GLenum usage
Definition: glcorearb.h:664
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
HgiBlendFactor dstColorBlendFactor
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLfloat f
Definition: glcorearb.h:1926
HgiBlendOp colorBlendOp
HgiAttachmentLoadOp loadOp
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:556
HgiBits HgiColorMask
Definition: enums.h:525
HgiBlendFactor srcAlphaBlendFactor