HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_GLF_UTILS_H
25 #define PXR_IMAGING_GLF_UTILS_H
26 
27 /// \file glf/utils.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/imaging/glf/api.h"
32 #include "pxr/imaging/hio/types.h"
33 
34 #include <string>
35 
37 
38 /// Number of elements.
39 ///
40 /// Returns the number of elements (channels) in a given GL enum format.
41 ///
42 /// Supported formats are : GL_DEPTH_COMPONENT, GL_COLOR_INDEX, GL_ALPHA,
43 /// GL_RED, GL_LUMINANCE, GL_RG, GL_LUMINANCE_ALPHA, GL_RGB, GL_RGBA
44 GLF_API
46 
47 /// Byte size of a GL type.
48 ///
49 /// Returns the size in bytes of a given GL type.
50 ///
51 /// Supported types are : GL_UNSIGNED_BYTE, GL_BYTE, GL_UNSIGNED_SHORT,
52 /// GL_SHORT, GL_FLOAT, GL_DOUBLE
53 GLF_API
55 
56 /// HioFormat
57 ///
58 /// Returns the HioFormat for the given GL format and GL type
59 ///
60 /// Supported formats are : GL_DEPTH_COMPONENT, GL_COLOR_INDEX, GL_ALPHA,
61 /// GL_RED, GL_LUMINANCE, GL_RG, GL_LUMINANCE_ALPHA, GL_RGB, GL_RGBA
62 ///
63 /// Supported types are : GL_UNSIGNED_BYTE, GL_BYTE, GL_UNSIGNED_SHORT,
64 /// GL_SHORT, GL_FLOAT, GL_DOUBLE
65 GLF_API
66 HioFormat GlfGetHioFormat(GLenum glFormat, GLenum glType, bool isSRGB);
67 
68 
69 /// Checks the valitidy of a GL framebuffer
70 ///
71 /// True if the currently bound GL framebuffer is valid and can be bound
72 /// or returns the cause of the problem
73 GLF_API
75 
77 
78 #endif
#define GLF_API
Definition: api.h:40
GLF_API bool GlfCheckGLFrameBufferStatus(GLuint target, std::string *reason)
GLF_API HioFormat GlfGetHioFormat(GLenum glFormat, GLenum glType, bool isSRGB)
unsigned int GLuint
Definition: cl.hpp:167
unsigned int GLenum
Definition: cl.hpp:166
PXR_NAMESPACE_OPEN_SCOPE GLF_API int GlfGetNumElements(GLenum format)
GLF_API int GlfGetElementSize(GLenum type)
GLenum target
Definition: glcorearb.h:1666
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
HioFormat
Definition: types.h:42
GLint GLint GLsizei GLint GLenum format
Definition: glcorearb.h:107
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91