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 HGI_GRAPHICS_ENCODER_DESC_H
25 #define 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 
55  : texture(nullptr)
56  , sampleCount(HgiSampleCount1)
57  , loadOp(HgiAttachmentLoadOpLoad)
58  , storeOp(HgiAttachmentStoreOpStore)
59  , clearValue(0)
60  {}
61 
62  HgiTextureHandle texture;
63  HgiSampleCount sampleCount;
64  HgiAttachmentLoadOp loadOp;
65  HgiAttachmentStoreOp storeOp;
66  GfVec4f clearValue;
67 };
68 
69 typedef std::vector<HgiAttachmentDesc> HgiAttachmentDescVector;
70 
71 HGI_API
72 bool operator==(
73  const HgiAttachmentDesc& lhs,
74  const HgiAttachmentDesc& rhs);
75 
76 HGI_API
77 bool operator!=(
78  const HgiAttachmentDesc& lhs,
79  const HgiAttachmentDesc& rhs);
80 
81 HGI_API
82 std::ostream& operator<<(
83  std::ostream& out,
84  const HgiAttachmentDesc& attachment);
85 
86 
104  : colorAttachments()
105  , depthAttachment()
106  , width(0)
107  , height(0)
108  {}
109 
110  inline bool HasAttachments() const {
111  return !colorAttachments.empty() || depthAttachment.texture;
112  }
113 
114  HgiAttachmentDescVector colorAttachments;
115  HgiAttachmentDesc depthAttachment;
116  uint32_t width;
117  uint32_t height;
118 };
119 
120 HGI_API
121 bool operator==(
122  const HgiGraphicsEncoderDesc& lhs,
123  const HgiGraphicsEncoderDesc& rhs);
124 
125 HGI_API
126 bool operator!=(
127  const HgiGraphicsEncoderDesc& lhs,
128  const HgiGraphicsEncoderDesc& rhs);
129 
130 HGI_API
131 std::ostream& operator<<(
132  std::ostream& out,
133  const HgiGraphicsEncoderDesc& encoder);
134 
135 
136 PXR_NAMESPACE_CLOSE_SCOPE
137 
138 #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)
Represents a graphics platform independent GPU texture resource.
Definition: texture.h:48
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].