| Flutter Impeller |

Public Types | Public Member Functions | Public Attributes | List of all members
impeller::GLProc< T > Struct Template Reference

`#include <proc_table_gles.h>`

## Public Types
using | GLFunctionType = T

## Public Member Functions
template<class... Args>
auto | operator() (Args &&... args) const
| Call the GL function with the appropriate parameters. Lookup the documentation for the GL function being called to understand the arguments and return types. The arguments types must match and will be type checked. More...
constexpr bool | IsAvailable () const
void | Reset ()

## Public Attributes
const char * | name = nullptr
GLFunctionType * | function = nullptr
PFNGLGETERRORPROC | error_fn = nullptr
bool | log_calls = false

## Detailed Description

### template<class T>
struct impeller::GLProc< T >

Definition at line 74 of file proc_table_gles.h.

## Member Typedef Documentation

## ◆ GLFunctionType

template<class T >

using impeller::GLProc< T >::GLFunctionType = T

Definition at line 75 of file proc_table_gles.h.

## Member Function Documentation

## ◆ IsAvailable()

template<class T >

constexpr bool impeller::GLProc< T >::IsAvailable | ( |  | ) | const
| inline constexpr

Definition at line 125 of file proc_table_gles.h.

125 { return function != nullptr; }

Referenced by impeller::GLProc< T >::operator()().

## ◆ operator()()

template<class T >
template<class... Args>

auto impeller::GLProc< T >::operator() | ( | Args &&... | args | ) | const
| inline

Call the GL function with the appropriate parameters. Lookup the documentation for the GL function being called to understand the arguments and return types. The arguments types must match and will be type checked.

Definition at line 109 of file proc_table_gles.h.

109 {
110 #if defined(IMPELLER_DEBUG) && !defined(NDEBUG)
111 AutoErrorCheck error(error_fn, name);
112 // We check for the existence of extensions, and reset the function pointer
113 // but it's still called unconditionally below, and will segfault. This
114 // validation log will at least give us a hint as to what's going on.
115 FML_CHECK(IsAvailable()) << "GL function " << name << " is not available. "
116 << "This is likely due to a missing extension.";
117 if (log_calls) {
118 FML_LOG(IMPORTANT) << name
119 << BuildGLArguments(std::forward<Args>(args)...);
120 }
121 #endif // defined(IMPELLER_DEBUG) && !defined(NDEBUG)
122 return function(std::forward<Args>(args)...);
123 }

References impeller::BuildGLArguments(), impeller::GLProc< T >::error_fn, impeller::GLProc< T >::IsAvailable(), impeller::GLProc< T >::log_calls, and impeller::GLProc< T >::name.

## ◆ Reset()

template<class T >

void impeller::GLProc< T >::Reset | ( |  | ) |
| inline

Definition at line 127 of file proc_table_gles.h.

127 {
128 function = nullptr;
129 error_fn = nullptr;
130 }

References impeller::GLProc< T >::error_fn.

## Member Data Documentation

## ◆ error_fn

template<class T >

PFNGLGETERRORPROC impeller::GLProc< T >::error_fn = nullptr

An optional error function. If present, all calls will be followed by an error check.

Definition at line 92 of file proc_table_gles.h.

Referenced by impeller::GLProc< T >::operator()(), and impeller::GLProc< T >::Reset().

## ◆ function

template<class T >

GLFunctionType* impeller::GLProc< T >::function = nullptr

The pointer to the GL function.

Definition at line 86 of file proc_table_gles.h.

## ◆ log_calls

template<class T >

bool impeller::GLProc< T >::log_calls = false

Whether the OpenGL call and its arguments should be logged.

Only works in IMPELLER_DEBUG and for environments where traditional tracing is hard. Expect log spam and only use during development.

Definition at line 100 of file proc_table_gles.h.

Referenced by impeller::GLProc< T >::operator()().

## ◆ name

template<class T >

const char* impeller::GLProc< T >::name = nullptr

The name of the GL function.

Definition at line 81 of file proc_table_gles.h.

Referenced by impeller::GLProc< T >::operator()().

The documentation for this struct was generated from the following file:

- impeller/renderer/backend/gles/proc_table_gles.h

impeller::GLProc::IsAvailable
constexpr bool IsAvailable() const
Definition: proc_table_gles.h:125
impeller::GLProc::error_fn
PFNGLGETERRORPROC error_fn
Definition: proc_table_gles.h:92
impeller::GLProc::log_calls
bool log_calls
Definition: proc_table_gles.h:100
impeller::BuildGLArguments
std::string BuildGLArguments(Type... args)
Definition: proc_table_gles.h:65
impeller::GLProc::name
const char * name
Definition: proc_table_gles.h:81