| 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
std::string_view | name = {}
GLFunctionType * | function = nullptr
PFNGLGETERRORPROC | error_fn = nullptr
bool | log_calls = false

## Detailed Description

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

Definition at line 79 of file proc_table_gles.h.

## Member Typedef Documentation

## ◆ GLFunctionType

template<class T >

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

Definition at line 80 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 128 of file proc_table_gles.h.

128 { 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 113 of file proc_table_gles.h.

113 {
114 #if defined(IMPELLER_DEBUG) && !defined(NDEBUG)
115 AutoErrorCheck error(error_fn, name);
116 // We check for the existence of extensions, and reset the function pointer
117 // but it's still called unconditionally below, and will segfault. This
118 // validation log will at least give us a hint as to what's going on.
119 FML_CHECK(IsAvailable()) << "GL function " << name << " is not available. "
120 << "This is likely due to a missing extension.";
121 if (log_calls) {
122 FML_LOG(IMPORTANT) << name << BuildGLArguments(args...);
123 }
124 #endif // defined(IMPELLER_DEBUG) && !defined(NDEBUG)
125 return function(std::forward<Args>(args)...);
126 }
impeller::BuildGLArguments
std::string BuildGLArguments(Type... args)
Definition: proc_table_gles.h:70
impeller::GLProc::log_calls
bool log_calls
Definition: proc_table_gles.h:104
impeller::GLProc::IsAvailable
constexpr bool IsAvailable() const
Definition: proc_table_gles.h:128
impeller::GLProc::name
std::string_view name
Definition: proc_table_gles.h:85
impeller::GLProc::error_fn
PFNGLGETERRORPROC error_fn
Definition: proc_table_gles.h:96

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 130 of file proc_table_gles.h.

130 {
131 function = nullptr;
132 error_fn = nullptr;
133 }

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 96 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 90 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 104 of file proc_table_gles.h.

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

## ◆ name

template<class T >

std::string_view impeller::GLProc< T >::name = {}

The name of the GL function.

Definition at line 85 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