Flutter Impeller
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
 
GLFunctionTypefunction = nullptr
 
PFNGLGETERRORPROC error_fn = nullptr
 
bool log_calls = false
 

Detailed Description

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

Definition at line 77 of file proc_table_gles.h.

Member Typedef Documentation

◆ GLFunctionType

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

Definition at line 78 of file proc_table_gles.h.

Member Function Documentation

◆ IsAvailable()

template<class T >
constexpr bool impeller::GLProc< T >::IsAvailable ( ) const
inlineconstexpr

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

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

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 95 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 89 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 103 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 84 of file proc_table_gles.h.

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


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