All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
graphicsEncoderDesc.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 PXR_IMAGING_HGI_GRAPHICS_ENCODER_DESC_H
25 #define PXR_IMAGING_HGI_GRAPHICS_ENCODER_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/texture.h"
31 #include "pxr/base/gf/vec4f.h"
32 #include <vector>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
53  : texture(nullptr)
54  , loadOp(HgiAttachmentLoadOpLoad)
55  , storeOp(HgiAttachmentStoreOpStore)
56  , clearValue(0)
57  {}
58 
59  HgiTextureHandle texture;
60  HgiAttachmentLoadOp loadOp;
61  HgiAttachmentStoreOp storeOp;
62  GfVec4f clearValue;
63 };
64 
65 typedef std::vector<HgiAttachmentDesc> HgiAttachmentDescVector;
66 
67 HGI_API
68 bool operator==(
69  const HgiAttachmentDesc& lhs,
70  const HgiAttachmentDesc& rhs);
71 
72 HGI_API
73 bool operator!=(
74  const HgiAttachmentDesc& lhs,
75  const HgiAttachmentDesc& rhs);
76 
77 HGI_API
78 std::ostream& operator<<(
79  std::ostream& out,
80  const HgiAttachmentDesc& attachment);
81 
82 
100  : colorAttachments()
101  , depthAttachment()
102  , width(0)
103  , height(0)
104  {}
105 
106  inline bool HasAttachments() const {
107  return !colorAttachments.empty() || depthAttachment.texture;
108  }
109 
110  HgiAttachmentDescVector colorAttachments;
111  HgiAttachmentDesc depthAttachment;
112  uint32_t width;
113  uint32_t height;
114 };
115 
116 HGI_API
117 bool operator==(
118  const HgiGraphicsEncoderDesc& lhs,
119  const HgiGraphicsEncoderDesc& rhs);
120 
121 HGI_API
122 bool operator!=(
123  const HgiGraphicsEncoderDesc& lhs,
124  const HgiGraphicsEncoderDesc& rhs);
125 
126 HGI_API
127 std::ostream& operator<<(
128  std::ostream& out,
129  const HgiGraphicsEncoderDesc& encoder);
130 
131 
132 PXR_NAMESPACE_CLOSE_SCOPE
133 
134 #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)
Describes the properties to begin a HgiGraphicsEncoder.
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].