 |
Wise&mystical
1.0
Project about Europe
|
Functions and types related to initialization and error handling. More...
Collaboration diagram for Initialization, version and error reference:Modules | |
| Error codes | |
| Error codes. | |
Macros | |
| #define | GLFW_TRUE 1 |
| One. More... | |
| #define | GLFW_FALSE 0 |
| Zero. More... | |
| #define | GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 |
| Joystick hat buttons init hint. More... | |
| #define | GLFW_ANGLE_PLATFORM_TYPE 0x00050002 |
| ANGLE rendering backend init hint. More... | |
| #define | GLFW_COCOA_CHDIR_RESOURCES 0x00051001 |
| macOS specific init hint. More... | |
| #define | GLFW_COCOA_MENUBAR 0x00051002 |
| macOS specific init hint. More... | |
| #define | GLFW_X11_XCB_VULKAN_SURFACE 0x00052001 |
| X11 specific init hint. More... | |
Typedefs | |
| typedef void(* | GLFWerrorfun) (int, const char *) |
| The function pointer type for error callbacks. More... | |
Functions | |
| GLFWAPI int | glfwInit (void) |
| GLFW API functions. More... | |
| GLFWAPI void | glfwTerminate (void) |
| Terminates the GLFW library. More... | |
| GLFWAPI void | glfwInitHint (int hint, int value) |
| Sets the specified init hint to the desired value. More... | |
| GLFWAPI void | glfwGetVersion (int *major, int *minor, int *rev) |
| Retrieves the version of the GLFW library. More... | |
| GLFWAPI const char * | glfwGetVersionString (void) |
| Returns a string describing the compile-time configuration. More... | |
| GLFWAPI int | glfwGetError (const char **description) |
| Returns and clears the last error for the calling thread. More... | |
| GLFWAPI GLFWerrorfun | glfwSetErrorCallback (GLFWerrorfun callback) |
| Sets the error callback. More... | |
GLFW version macros | |
GLFW API tokens | |
| #define | GLFW_VERSION_MAJOR 3 |
| The major version number of the GLFW header. More... | |
| #define | GLFW_VERSION_MINOR 4 |
| The minor version number of the GLFW header. More... | |
| #define | GLFW_VERSION_REVISION 0 |
| The revision number of the GLFW header. More... | |
Functions and types related to initialization and error handling.
This is the reference documentation for initialization and termination of the library, version management and error handling. For more task-oriented information, see the intro_guide.
| #define GLFW_ANGLE_PLATFORM_TYPE 0x00050002 |
| #define GLFW_COCOA_CHDIR_RESOURCES 0x00051001 |
| #define GLFW_COCOA_MENUBAR 0x00051002 |
| #define GLFW_FALSE 0 |
| #define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 |
| #define GLFW_TRUE 1 |
| #define GLFW_VERSION_MAJOR 3 |
| #define GLFW_VERSION_MINOR 4 |
| #define GLFW_VERSION_REVISION 0 |
| #define GLFW_X11_XCB_VULKAN_SURFACE 0x00052001 |
| typedef void(* GLFWerrorfun) (int, const char *) |
The function pointer type for error callbacks.
This is the function pointer type for error callbacks. An error callback function has the following signature:
| [in] | error_code | An error code. Future releases may add more error codes. |
| [in] | description | A UTF-8 encoded string describing the error. |
@pointer_lifetime The error description string is valid until the callback function returns.
| GLFWAPI int glfwGetError | ( | const char ** | description | ) |
Returns and clears the last error for the calling thread.
This function returns and clears the error code of the last error that occurred on the calling thread, and optionally a UTF-8 encoded human-readable description of it. If no error has occurred since the last call, it returns GLFW_NO_ERROR (zero) and the description pointer is set to NULL.
| [in] | description | Where to store the error description pointer, or NULL. |
@errors None.
@pointer_lifetime The returned string is allocated and freed by GLFW. You should not free it yourself. It is guaranteed to be valid only until the next error occurs or the library is terminated.
@thread_safety This function may be called from any thread.
Definition at line 328 of file init.c.
Here is the call graph for this function:| GLFWAPI void glfwGetVersion | ( | int * | major, |
| int * | minor, | ||
| int * | rev | ||
| ) |
Retrieves the version of the GLFW library.
This function retrieves the major, minor and revision numbers of the GLFW library. It is intended for when you are using GLFW as a shared library and want to ensure that you are using the minimum required version.
Any or all of the version arguments may be NULL.
| [out] | major | Where to store the major version number, or NULL. |
| [out] | minor | Where to store the minor version number, or NULL. |
| [out] | rev | Where to store the revision number, or NULL. |
@errors None.
@thread_safety This function may be called from any thread.
| GLFWAPI const char * glfwGetVersionString | ( | void | ) |
Returns a string describing the compile-time configuration.
This function returns the compile-time generated version string of the GLFW library binary. It describes the version, platform, compiler and any platform-specific compile-time options. It should not be confused with the OpenGL or OpenGL ES version string, queried with glGetString.
Do not use the version string to parse the GLFW library version. The glfwGetVersion function provides the version of the running library binary in numerical format.
@errors None.
@pointer_lifetime The returned string is static and compile-time generated.
@thread_safety This function may be called from any thread.
Definition at line 323 of file init.c.
Here is the call graph for this function:| GLFWAPI int glfwInit | ( | void | ) |
GLFW API functions.
Initializes the GLFW library.
This function initializes the GLFW library. Before most GLFW functions can be used, GLFW must be initialized, and before an application terminates GLFW should be terminated in order to free any resources allocated during or after initialization.
If this function fails, it calls glfwTerminate before returning. If it succeeds, you should call glfwTerminate before the application exits.
Additional calls to this function after successful initialization but before termination will return GLFW_TRUE immediately.
GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.@errors Possible errors include GLFW_PLATFORM_ERROR.
Contents/Resources subdirectory of the application's bundle, if present. This can be disabled with the GLFW_COCOA_CHDIR_RESOURCES init hint.MainMenu.nib it is loaded and assumed to contain a menu bar. Otherwise a minimal menu bar is created manually with common commands like Hide, Quit and About. The About entry opens a minimal about dialog with information from the application's bundle. The menu bar and dock icon can be disabled entirely with the GLFW_COCOA_MENUBAR init hint.LC_CTYPE category of the application locale according to the current environment if that category is still "C". This is because the "C" locale breaks Unicode text input.@thread_safety This function must only be called from the main thread.
Definition at line 235 of file init.c.
Here is the call graph for this function:| GLFWAPI void glfwInitHint | ( | int | hint, |
| int | value | ||
| ) |
Sets the specified init hint to the desired value.
This function sets hints for the next initialization of GLFW.
The values you set hints to are never reset by GLFW, but they only take effect during initialization. Once GLFW has been initialized, any values you set will be ignored until the library is terminated and initialized again.
Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.
| [in] | hint | The init hint to set. |
| [in] | value | The new value of the init hint. |
@errors Possible errors include GLFW_INVALID_ENUM and GLFW_INVALID_VALUE.
@thread_safety This function must only be called from the main thread.
Definition at line 288 of file init.c.
Here is the call graph for this function:| GLFWAPI GLFWerrorfun glfwSetErrorCallback | ( | GLFWerrorfun | callback | ) |
Sets the error callback.
This function sets the error callback, which is called with an error code and a human-readable description each time a GLFW error occurs.
The error code is set before the callback is called. Calling glfwGetError from the error callback will return the same value as the error code argument.
The error callback is called on the thread where the error occurred. If you are using GLFW from multiple threads, your error callback needs to be written accordingly.
Because the description string may have been generated specifically for that error, it is not guaranteed to be valid after the callback has returned. If you wish to use it after the callback returns, you need to make a copy.
Once set, the error callback remains set even after the library has been terminated.
| [in] | callback | The new callback, or NULL to remove the currently set callback. |
NULL if no callback was set.@callback_signature
For more information about the callback parameters, see the callback pointer type.
@errors None.
@thread_safety This function must only be called from the main thread.
| GLFWAPI void glfwTerminate | ( | void | ) |
Terminates the GLFW library.
This function destroys all remaining windows and cursors, restores any modified gamma ramps and frees any other allocated resources. Once this function is called, you must again call glfwInit successfully before you will be able to use most GLFW functions.
If GLFW has been successfully initialized, this function should be called before the application exits. If initialization fails, there is no need to call this function, as it is called by glfwInit before it returns failure.
This function has no effect if GLFW is not initialized.
@errors Possible errors include GLFW_PLATFORM_ERROR.
@reentrancy This function must not be called from a callback.
@thread_safety This function must only be called from the main thread.
Definition at line 280 of file init.c.
Here is the caller graph for this function:
1.9.5