Crate glfw_bindgen

Expand description

glfw-bindgen

Bindings to GLFW generated with rust-bindgen.

While compiling this crate, it generates all the binding code and compiles GLFW from source.

Used GLFW version

Git revision dd8a678.

Features

wayland: Enables Wayland support. Please note that currently GLFW still prefers X11 if available, though you can bypass this by setting DISPLAY=.

Licensing

This project (and GLFW itself) is licensed under the zlib License.

Structs

GLFWallocator

@brief

GLFWcursor

GLFWgamepadstate

@brief Gamepad input state

@brief Gamma ramp.

@brief Image data.

@brief Video mode type.

GLFWwindow

_XDisplay

Constants

GLFW_ACCUM_ALPHA_BITS

GLFW_ACCUM_BLUE_BITS

GLFW_ACCUM_GREEN_BITS

GLFW_ACCUM_RED_BITS

GLFW_ALPHA_BITS

GLFW_ANGLE_PLATFORM_TYPE

GLFW_ANGLE_PLATFORM_TYPE_D3D9

GLFW_ANGLE_PLATFORM_TYPE_D3D11

GLFW_ANGLE_PLATFORM_TYPE_METAL

GLFW_ANGLE_PLATFORM_TYPE_NONE

GLFW_ANGLE_PLATFORM_TYPE_OPENGL

GLFW_ANGLE_PLATFORM_TYPE_OPENGLES

GLFW_ANGLE_PLATFORM_TYPE_VULKAN

GLFW_ANY_PLATFORM

GLFW_ANY_POSITION

GLFW_ANY_RELEASE_BEHAVIOR

GLFW_COCOA_CHDIR_RESOURCES

GLFW_COCOA_FRAME_NAME

GLFW_COCOA_GRAPHICS_SWITCHING

GLFW_COCOA_MENUBAR

GLFW_COCOA_RETINA_FRAMEBUFFER

GLFW_CONNECTED

GLFW_CONTEXT_CREATION_API

GLFW_CONTEXT_DEBUG

GLFW_CONTEXT_NO_ERROR

GLFW_CONTEXT_RELEASE_BEHAVIOR

GLFW_CONTEXT_REVISION

GLFW_CONTEXT_ROBUSTNESS

GLFW_CONTEXT_VERSION_MAJOR

GLFW_CONTEXT_VERSION_MINOR

GLFW_CROSSHAIR_CURSOR

GLFW_CURSOR_UNAVAILABLE

GLFW_FEATURE_UNAVAILABLE

GLFW_FEATURE_UNIMPLEMENTED

GLFW_FLOATING

GLFW_FOCUSED

GLFW_FOCUS_ON_SHOW

GLFW_FORMAT_UNAVAILABLE

GLFW_GAMEPAD_AXIS_LAST

GLFW_GAMEPAD_AXIS_LEFT_TRIGGER

GLFW_GAMEPAD_AXIS_LEFT_X

GLFW_GAMEPAD_AXIS_LEFT_Y

GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER

GLFW_GAMEPAD_AXIS_RIGHT_X

GLFW_GAMEPAD_AXIS_RIGHT_Y

GLFW_GAMEPAD_BUTTON_A

GLFW_GAMEPAD_BUTTON_B

GLFW_GAMEPAD_BUTTON_BACK

GLFW_GAMEPAD_BUTTON_CIRCLE

GLFW_GAMEPAD_BUTTON_CROSS

GLFW_GAMEPAD_BUTTON_DPAD_DOWN

GLFW_GAMEPAD_BUTTON_DPAD_LEFT

GLFW_GAMEPAD_BUTTON_DPAD_RIGHT

GLFW_GAMEPAD_BUTTON_DPAD_UP

GLFW_GAMEPAD_BUTTON_GUIDE

GLFW_GAMEPAD_BUTTON_LAST

GLFW_GAMEPAD_BUTTON_LEFT_BUMPER

GLFW_GAMEPAD_BUTTON_LEFT_THUMB

GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER

GLFW_GAMEPAD_BUTTON_RIGHT_THUMB

GLFW_GAMEPAD_BUTTON_SQUARE

GLFW_GAMEPAD_BUTTON_START

GLFW_GAMEPAD_BUTTON_TRIANGLE

GLFW_GAMEPAD_BUTTON_X

GLFW_GAMEPAD_BUTTON_Y

GLFW_JOYSTICK_HAT_BUTTONS

GLFW_KEY_GRAVE_ACCENT

GLFW_KEY_LEFT_BRACKET

GLFW_KEY_LEFT_CONTROL

GLFW_KEY_PRINT_SCREEN

GLFW_KEY_RIGHT_BRACKET

GLFW_KEY_RIGHT_CONTROL

GLFW_LOSE_CONTEXT_ON_RESET

GLFW_MOUSE_BUTTON_LAST

GLFW_MOUSE_BUTTON_LEFT

GLFW_MOUSE_BUTTON_MIDDLE

GLFW_MOUSE_BUTTON_RIGHT

GLFW_MOUSE_PASSTHROUGH

GLFW_NATIVE_CONTEXT_API

GLFW_NOT_ALLOWED_CURSOR

GLFW_NOT_INITIALIZED

GLFW_NO_API

GLFW_NO_CURRENT_CONTEXT

GLFW_NO_ERROR

GLFW_NO_RESET_NOTIFICATION

GLFW_NO_ROBUSTNESS

GLFW_NO_WINDOW_CONTEXT

GLFW_OPENGL_ANY_PROFILE

GLFW_OPENGL_API

GLFW_OPENGL_COMPAT_PROFILE

GLFW_OPENGL_CORE_PROFILE

GLFW_OPENGL_DEBUG_CONTEXT

GLFW_OPENGL_ES_API

GLFW_OPENGL_FORWARD_COMPAT

GLFW_OPENGL_PROFILE

GLFW_OSMESA_CONTEXT_API

GLFW_PLATFORM_UNAVAILABLE

GLFW_PLATFORM_WAYLAND

GLFW_PLATFORM_WIN32

GLFW_PLATFORM_X11

GLFW_POINTING_HAND_CURSOR

GLFW_POSITION_X

GLFW_POSITION_Y

GLFW_PRESS

GLFW_RAW_MOUSE_MOTION

GLFW_RED_BITS

GLFW_REFRESH_RATE

GLFW_RELEASE

GLFW_RELEASE_BEHAVIOR_FLUSH

GLFW_RELEASE_BEHAVIOR_NONE

GLFW_REPEAT

GLFW_RESIZABLE

GLFW_RESIZE_ALL_CURSOR

GLFW_RESIZE_EW_CURSOR

GLFW_RESIZE_NESW_CURSOR

GLFW_RESIZE_NS_CURSOR

GLFW_RESIZE_NWSE_CURSOR

GLFW_SAMPLES

GLFW_SCALE_TO_MONITOR

GLFW_STICKY_MOUSE_BUTTONS

GLFW_TRANSPARENT_FRAMEBUFFER

GLFW_TRUE

GLFW_VERSION_MAJOR

GLFW_VERSION_MINOR

GLFW_VERSION_REVISION

GLFW_VERSION_UNAVAILABLE

GLFW_VISIBLE

GLFW_VRESIZE_CURSOR

GLFW_WAYLAND_APP_ID

GLFW_WIN32_KEYBOARD_MENU

GLFW_X11_CLASS_NAME

GLFW_X11_INSTANCE_NAME

GLFW_X11_XCB_VULKAN_SURFACE

Functions

glfwCreateCursor^⚠

@brief Creates a custom cursor.

glfwCreateStandardCursor^⚠

@brief Creates a cursor with a standard shape.

glfwCreateWindow^⚠

@brief Creates a window and its associated context.

glfwDefaultWindowHints^⚠

@brief Resets all window hints to their default values.

glfwDestroyCursor^⚠

@brief Destroys a cursor.

glfwDestroyWindow^⚠

@brief Destroys the specified window and its context.

glfwExtensionSupported^⚠

@brief Returns whether the specified extension is available.

glfwFocusWindow^⚠

@brief Brings the specified window to front and sets input focus.

glfwGetClipboardString^⚠

@brief Returns the contents of the clipboard as a string.

glfwGetCurrentContext^⚠

@brief Returns the window whose context is current on the calling thread.

glfwGetCursorPos^⚠

@brief Retrieves the position of the cursor relative to the content area of the window.

glfwGetError^⚠

@brief Returns and clears the last error for the calling thread.

glfwGetFramebufferSize^⚠

@brief Retrieves the size of the framebuffer of the specified window.

glfwGetGamepadName^⚠

@brief Returns the human-readable gamepad name for the specified joystick.

glfwGetGamepadState^⚠

@brief Retrieves the state of the specified joystick remapped as a gamepad.

glfwGetGammaRamp^⚠

@brief Returns the current gamma ramp for the specified monitor.

glfwGetInputMode^⚠

@brief Returns the value of an input option for the specified window.

glfwGetJoystickAxes^⚠

@brief Returns the values of all axes of the specified joystick.

glfwGetJoystickButtons^⚠

@brief Returns the state of all buttons of the specified joystick.

glfwGetJoystickGUID^⚠

@brief Returns the SDL compatible GUID of the specified joystick.

glfwGetJoystickHats^⚠

@brief Returns the state of all hats of the specified joystick.

glfwGetJoystickName^⚠

@brief Returns the name of the specified joystick.

glfwGetJoystickUserPointer^⚠

@brief Returns the user pointer of the specified joystick.

glfwGetKey^⚠

@brief Returns the last reported state of a keyboard key for the specified window.

glfwGetKeyName^⚠

@brief Returns the layout-specific name of the specified printable key.

glfwGetKeyScancode^⚠

@brief Returns the platform-specific scancode of the specified key.

glfwGetMonitorContentScale^⚠

@brief Retrieves the content scale for the specified monitor.

glfwGetMonitorName^⚠

@brief Returns the name of the specified monitor.

glfwGetMonitorPhysicalSize^⚠

@brief Returns the physical size of the monitor.

glfwGetMonitorPos^⚠

@brief Returns the position of the monitor’s viewport on the virtual screen.

glfwGetMonitorUserPointer^⚠

@brief Returns the user pointer of the specified monitor.

glfwGetMonitorWorkarea^⚠

@brief Retrieves the work area of the monitor.

glfwGetMonitors^⚠

@brief Returns the currently connected monitors.

glfwGetMouseButton^⚠

@brief Returns the last reported state of a mouse button for the specified window.

glfwGetPlatform^⚠

@brief Returns the currently selected platform.

glfwGetPrimaryMonitor^⚠

@brief Returns the primary monitor.

glfwGetProcAddress^⚠

@brief Returns the address of the specified function for the current context.

glfwGetRequiredInstanceExtensions^⚠

@brief Returns the Vulkan instance extensions required by GLFW.

glfwGetTime^⚠

@brief Returns the GLFW time.

glfwGetTimerFrequency^⚠

@brief Returns the frequency, in Hz, of the raw timer.

glfwGetTimerValue^⚠

@brief Returns the current value of the raw timer.

glfwGetVersion^⚠

@brief Retrieves the version of the GLFW library.

glfwGetVersionString^⚠

@brief Returns a string describing the compile-time configuration.

glfwGetVideoMode^⚠

@brief Returns the current mode of the specified monitor.

glfwGetVideoModes^⚠

@brief Returns the available video modes for the specified monitor.

glfwGetWindowAttrib^⚠

@brief Returns an attribute of the specified window.

glfwGetWindowContentScale^⚠

@brief Retrieves the content scale for the specified window.

glfwGetWindowFrameSize^⚠

@brief Retrieves the size of the frame of the window.

glfwGetWindowMonitor^⚠

@brief Returns the monitor that the window uses for full screen mode.

glfwGetWindowOpacity^⚠

@brief Returns the opacity of the whole window.

glfwGetWindowPos^⚠

@brief Retrieves the position of the content area of the specified window.

glfwGetWindowSize^⚠

@brief Retrieves the size of the content area of the specified window.

glfwGetWindowUserPointer^⚠

@brief Returns the user pointer of the specified window.

glfwGetX11Adapter^⚠

@brief Returns the RRCrtc of the specified monitor.

glfwGetX11Display^⚠

@brief Returns the Display used by GLFW.

glfwGetX11Monitor^⚠

@brief Returns the RROutput of the specified monitor.

glfwGetX11SelectionString^⚠

@brief Returns the contents of the current primary selection as a string.

glfwGetX11Window^⚠

@brief Returns the Window of the specified window.

glfwHideWindow^⚠

@brief Hides the specified window.

glfwIconifyWindow^⚠

@brief Iconifies the specified window.

glfwInit^⚠

@brief Initializes the GLFW library.

glfwInitAllocator^⚠

@brief Sets the init allocator to the desired value.

glfwInitHint^⚠

@brief Sets the specified init hint to the desired value.

glfwJoystickIsGamepad^⚠

@brief Returns whether the specified joystick has a gamepad mapping.

glfwJoystickPresent^⚠

@brief Returns whether the specified joystick is present.

glfwMakeContextCurrent^⚠

@brief Makes the context of the specified window current for the calling thread.

glfwMaximizeWindow^⚠

@brief Maximizes the specified window.

glfwPlatformSupported^⚠

@brief Returns whether the library includes support for the specified platform.

glfwPollEvents^⚠

@brief Processes all pending events.

glfwPostEmptyEvent^⚠

@brief Posts an empty event to the event queue.

glfwRawMouseMotionSupported^⚠

@brief Returns whether raw mouse motion is supported.

glfwRequestWindowAttention^⚠

@brief Requests user attention to the specified window.

glfwRestoreWindow^⚠

@brief Restores the specified window.

glfwSetCharCallback^⚠

@brief Sets the Unicode character callback.

glfwSetCharModsCallback^⚠

@brief Sets the Unicode character with modifiers callback.

glfwSetClipboardString^⚠

@brief Sets the clipboard to the specified string.

glfwSetCursor^⚠

@brief Sets the cursor for the window.

glfwSetCursorEnterCallback^⚠

@brief Sets the cursor enter/leave callback.

glfwSetCursorPos^⚠

@brief Sets the position of the cursor, relative to the content area of the window.

glfwSetCursorPosCallback^⚠

@brief Sets the cursor position callback.

glfwSetDropCallback^⚠

@brief Sets the path drop callback.

glfwSetErrorCallback^⚠

@brief Sets the error callback.

glfwSetFramebufferSizeCallback^⚠

@brief Sets the framebuffer resize callback for the specified window.

glfwSetGamma^⚠

@brief Generates a gamma ramp and sets it for the specified monitor.

glfwSetGammaRamp^⚠

@brief Sets the current gamma ramp for the specified monitor.

glfwSetInputMode^⚠

@brief Sets an input option for the specified window.

glfwSetJoystickCallback^⚠

@brief Sets the joystick configuration callback.

glfwSetJoystickUserPointer^⚠

@brief Sets the user pointer of the specified joystick.

glfwSetKeyCallback^⚠

@brief Sets the key callback.

glfwSetMonitorCallback^⚠

@brief Sets the monitor configuration callback.

glfwSetMonitorUserPointer^⚠

@brief Sets the user pointer of the specified monitor.

glfwSetMouseButtonCallback^⚠

@brief Sets the mouse button callback.

glfwSetScrollCallback^⚠

@brief Sets the scroll callback.

glfwSetTime^⚠

@brief Sets the GLFW time.

glfwSetWindowAspectRatio^⚠

@brief Sets the aspect ratio of the specified window.

glfwSetWindowAttrib^⚠

@brief Sets an attribute of the specified window.

glfwSetWindowCloseCallback^⚠

@brief Sets the close callback for the specified window.

glfwSetWindowContentScaleCallback^⚠

@brief Sets the window content scale callback for the specified window.

glfwSetWindowFocusCallback^⚠

@brief Sets the focus callback for the specified window.

glfwSetWindowIcon^⚠

@brief Sets the icon for the specified window.

glfwSetWindowIconifyCallback^⚠

@brief Sets the iconify callback for the specified window.

glfwSetWindowMaximizeCallback^⚠

@brief Sets the maximize callback for the specified window.

glfwSetWindowMonitor^⚠

@brief Sets the mode, monitor, video mode and placement of a window.

glfwSetWindowOpacity^⚠

@brief Sets the opacity of the whole window.

glfwSetWindowPos^⚠

@brief Sets the position of the content area of the specified window.

glfwSetWindowPosCallback^⚠

@brief Sets the position callback for the specified window.

glfwSetWindowRefreshCallback^⚠

@brief Sets the refresh callback for the specified window.

glfwSetWindowShouldClose^⚠

@brief Sets the close flag of the specified window.

glfwSetWindowSize^⚠

@brief Sets the size of the content area of the specified window.

glfwSetWindowSizeCallback^⚠

@brief Sets the size callback for the specified window.

glfwSetWindowSizeLimits^⚠

@brief Sets the size limits of the specified window.

glfwSetWindowTitle^⚠

@brief Sets the title of the specified window.

glfwSetWindowUserPointer^⚠

@brief Sets the user pointer of the specified window.

glfwSetX11SelectionString^⚠

@brief Sets the current primary selection to the specified string.

glfwShowWindow^⚠

@brief Makes the specified window visible.

glfwSwapBuffers^⚠

@brief Swaps the front and back buffers of the specified window.

glfwSwapInterval^⚠

@brief Sets the swap interval for the current context.

glfwTerminate^⚠

@brief Terminates the GLFW library.

glfwUpdateGamepadMappings^⚠

@brief Adds the specified SDL_GameControllerDB gamepad mappings.

glfwVulkanSupported^⚠

@brief Returns whether the Vulkan loader and an ICD have been found.

glfwWaitEvents^⚠

@brief Waits until events are queued and processes them.

glfwWaitEventsTimeout^⚠

@brief Waits with timeout until events are queued and processes them.

glfwWindowHint^⚠

@brief Sets the specified window hint to the desired value.

glfwWindowHintString^⚠

@brief Sets the specified window hint to the desired value.

glfwWindowShouldClose^⚠

@brief Checks the close flag of the specified window.

Type Definitions

Display

GLFWallocatefun

@brief The function pointer type for memory allocation callbacks.

GLFWcharfun

@brief The function pointer type for Unicode character callbacks.

GLFWcharmodsfun

@brief The function pointer type for Unicode character with modifiers callbacks.

GLFWcursorenterfun

@brief The function pointer type for cursor enter/leave callbacks.

GLFWcursorposfun

@brief The function pointer type for cursor position callbacks.

GLFWdeallocatefun

@brief The function pointer type for memory deallocation callbacks.

GLFWdropfun

@brief The function pointer type for path drop callbacks.

GLFWerrorfun

@brief The function pointer type for error callbacks.

GLFWframebuffersizefun

@brief The function pointer type for framebuffer size callbacks.

GLFWglproc

@brief Client API function pointer type.

GLFWjoystickfun

@brief The function pointer type for joystick configuration callbacks.

GLFWkeyfun

@brief The function pointer type for keyboard key callbacks.

GLFWmonitorfun

@brief The function pointer type for monitor configuration callbacks.

GLFWmousebuttonfun

@brief The function pointer type for mouse button callbacks.

GLFWreallocatefun

@brief The function pointer type for memory reallocation callbacks.

GLFWscrollfun

@brief The function pointer type for scroll callbacks.

GLFWwindowclosefun

@brief The function pointer type for window close callbacks.

GLFWwindowcontentscalefun

@brief The function pointer type for window content scale callbacks.

GLFWwindowfocusfun

@brief The function pointer type for window focus callbacks.

GLFWwindowiconifyfun

@brief The function pointer type for window iconify callbacks.

GLFWwindowmaximizefun

@brief The function pointer type for window maximize callbacks.

GLFWwindowposfun

@brief The function pointer type for window position callbacks.

GLFWwindowrefreshfun

@brief The function pointer type for window content refresh callbacks.

GLFWwindowsizefun

@brief The function pointer type for window size callbacks.