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/attachmentDesc.h"
30 #include "pxr/imaging/hgi/texture.h"
31 #include <vector>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
56 {
58  : colorAttachmentDescs()
59  , depthAttachmentDesc()
60  , colorTextures()
61  , depthTexture()
62  , width(0)
63  , height(0)
64  {}
65 
66  inline bool HasAttachments() const {
67  return !colorAttachmentDescs.empty() || depthTexture;
68  }
69 
70  HgiAttachmentDescVector colorAttachmentDescs;
71  HgiAttachmentDesc depthAttachmentDesc;
72 
73  HgiTextureHandleVector colorTextures;
74  HgiTextureHandle depthTexture;
75 
76  uint32_t width;
77  uint32_t height;
78 };
79 
80 HGI_API
81 bool operator==(
82  const HgiGraphicsEncoderDesc& lhs,
83  const HgiGraphicsEncoderDesc& rhs);
84 
85 HGI_API
86 bool operator!=(
87  const HgiGraphicsEncoderDesc& lhs,
88  const HgiGraphicsEncoderDesc& rhs);
89 
90 HGI_API
91 std::ostream& operator<<(
92  std::ostream& out,
93  const HgiGraphicsEncoderDesc& encoder);
94 
95 
96 PXR_NAMESPACE_CLOSE_SCOPE
97 
98 #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.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].