All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
attachmentDesc.h
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 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
58 {
60  : format(HgiFormatInvalid)
61  , loadOp(HgiAttachmentLoadOpLoad)
62  , storeOp(HgiAttachmentStoreOpStore)
63  , clearValue(0)
64  , blendEnabled(false)
65  , srcColorBlendFactor(HgiBlendFactorZero)
66  , dstColorBlendFactor(HgiBlendFactorZero)
67  , colorBlendOp(HgiBlendOpAdd)
68  , srcAlphaBlendFactor(HgiBlendFactorZero)
69  , dstAlphaBlendFactor(HgiBlendFactorZero)
70  , alphaBlendOp(HgiBlendOpAdd)
71  {}
72 
73  HgiFormat format;
74  HgiAttachmentLoadOp loadOp;
75  HgiAttachmentStoreOp storeOp;
76  GfVec4f clearValue;
77  bool blendEnabled;
78  HgiBlendFactor srcColorBlendFactor;
79  HgiBlendFactor dstColorBlendFactor;
80  HgiBlendOp colorBlendOp;
81  HgiBlendFactor srcAlphaBlendFactor;
82  HgiBlendFactor dstAlphaBlendFactor;
83  HgiBlendOp alphaBlendOp;
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,
101  const HgiAttachmentDesc& attachment);
102 
103 
104 PXR_NAMESPACE_CLOSE_SCOPE
105 
106 #endif
Describes the properties of a framebuffer attachment.
AR_API bool operator!=(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
AR_API bool operator==(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
Basic type for a vector of 4 float components.
Definition: vec4f.h:63
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].