HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
hgiConversions.h
Go to the documentation of this file.
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_HD_ST_HGI_CONVERSIONS_H
25 #define PXR_IMAGING_HD_ST_HGI_CONVERSIONS_H
26 
27 #include "pxr/imaging/hdSt/api.h"
28 #include "pxr/imaging/hd/enums.h"
29 #include "pxr/imaging/hd/types.h"
30 #include "pxr/imaging/hgi/types.h"
31 #include "pxr/imaging/hgi/enums.h"
32 
34 
35 ///
36 /// \class HdStHgiConversions
37 ///
38 /// Converts from Hd types to Hgi types
39 ///
41 {
42 public:
43 
44  HDST_API
45  static HgiFormat GetHgiFormat(HdFormat hdFormat);
46 
47  HDST_API
48  static HgiFormat GetHgiVertexFormat(HdType hdType);
49 
50  HDST_API
52 
53  HDST_API
54  static HgiSamplerFilter GetHgiMagFilter(HdMagFilter hdMagFilter);
55 
56  /// The HdMinFilter translates into two Hgi enums for
57  /// HgiSamplerDesc::minFilter and HgiSamplerDesc::mipFilter.
58  ///
59  HDST_API
60  static void GetHgiMinAndMipFilter(
61  HdMinFilter hdMinFilter,
62  HgiSamplerFilter *hgiSamplerFilter, HgiMipFilter *hgiMipFilter);
63 
64  HDST_API
65  static HgiBorderColor GetHgiBorderColor(HdBorderColor hdBorderColor);
66 
67  HDST_API
69  HdCompareFunction hdCompareFunc);
70 
71  HDST_API
72  static HgiStencilOp GetHgiStencilOp(HdStencilOp hdStencilOp);
73 };
74 
75 
77 
78 #endif
HgiSamplerAddressMode
Definition: enums.h:173
HgiStencilOp
Definition: enums.h:559
HdCompareFunction
Definition: enums.h:36
HdFormat
Definition: types.h:423
HdWrap
Definition: types.h:54
HgiCompareFunction
Definition: enums.h:541
HgiMipFilter
Definition: enums.h:216
static HDST_API void GetHgiMinAndMipFilter(HdMinFilter hdMinFilter, HgiSamplerFilter *hgiSamplerFilter, HgiMipFilter *hgiMipFilter)
HgiFormat
Definition: types.h:45
static HDST_API HgiFormat GetHgiVertexFormat(HdType hdType)
HgiBorderColor
Definition: enums.h:235
HdMinFilter
Definition: types.h:81
HdBorderColor
Definition: types.h:116
static HDST_API HgiFormat GetHgiFormat(HdFormat hdFormat)
static HDST_API HgiSamplerAddressMode GetHgiSamplerAddressMode(HdWrap hdWrap)
HdMagFilter
Definition: types.h:100
HdStencilOp
Definition: enums.h:54
static HDST_API HgiCompareFunction GetHgiCompareFunction(HdCompareFunction hdCompareFunc)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HDST_API HgiStencilOp GetHgiStencilOp(HdStencilOp hdStencilOp)
static HDST_API HgiSamplerFilter GetHgiMagFilter(HdMagFilter hdMagFilter)
HdType
Definition: types.h:287
HgiSamplerFilter
Definition: enums.h:195
static HDST_API HgiBorderColor GetHgiBorderColor(HdBorderColor hdBorderColor)