Struct glfw::Glfw[][src]

pub struct Glfw;

A token from which to call various GLFW functions. It can be obtained by calling the init function. This cannot be sent to other tasks, and should only be initialized on the main platform thread. Whilst this might make performing some operations harder, this is to ensure thread safety is enforced statically. The context can be safely cloned or implicitly copied if need be for convenience.

Methods

impl Glfw
[src]

Sets the error callback, overwriting the previous one stored.

Example

This example is not tested
use std::cell::Cell;

fn error_callback(_: glfw::Error, description: String, error_count: &Cell<usize>) {
    println!("GLFW error {}: {}", error_count.get(), description);
    error_count.set(error_count.get() + 1);
}

// sets a new callback
glfw.set_error_callback(Some(
    glfw::Callback {
        f: error_callback,
        data: Cell::new(0),
    }
));

// removes the previously set callback
glfw.set_error_callback(None);

The FAIL_ON_ERRORS and LOG_ERRORS callbacks are provided for convenience. For example:

This example is not tested
// triggers a task failure when a GLFW error is encountered.
glfw.set_error_callback(glfw::FAIL_ON_ERRORS);

Sets the monitor callback, overwriting the previous one stored.

Sets the joystick callback, overwriting the previous one stored

Supplies the primary monitor to the closure provided, if it exists. This is usually the monitor where elements like the Windows task bar or the OS X menu bar is located.

Example

This example is not tested
let (window, events) = glfw.with_primary_monitor(|m| {
    glfw.create_window(300, 300, "Hello this is window",
        m.map_or(glfw::WindowMode::Windowed, |m| glfw::FullScreen(m)))
}).expect("Failed to create GLFW window.");

Supplies the primary monitor to the closure provided, if it exists. This is usually the monitor where elements like the Windows task bar or the OS X menu bar is located.

Variant that can accept an FnMut closure.

Example

This example is not tested
glfw.with_primary_monitor(|_: &mut _, m: Option<&glfw::Monitor>| {
    let monitor = m.unwrap();

    let mode: glfw::VidMode = monitor.get_video_mode().unwrap();

    // Modifying `window` requires `FnMut`
    window.set_monitor(glfw::WindowMode::FullScreen(&monitor), 0, 0, mode.width, mode.height, Some(mode.refresh_rate));
});

Supplies a vector of the currently connected monitors to the closure provided.

Example

This example is not tested
glfw.with_connected_monitors(|monitors| {
    for monitor in monitors.iter() {
        println!("{}: {}", monitor.get_name(), monitor.get_video_mode());
    }
});

Supplies a vector of the currently connected monitors to the closure provided.

Variant that can accept an FnMut closure.

Example

This example is not tested
glfw.with_connected_monitors(|monitors| {
    for monitor in monitors.iter() {
        println!("{}: {}", monitor.get_name(), monitor.get_video_mode());
    }
});

This is used to set the window hints for the next call to Glfw::create_window. The hints can be reset to their default values using calling the Glfw::default_window_hints function.

Wrapper for glfwWindowHint

OpenGL 3.x and 4.x on Mac OS X

The only OpenGL 3.x and 4.x contexts supported by OS X are forward-compatible, core profile contexts.

10.7 and 10.8 support the following OpenGL versions:

  • glfw::WindowHint::ContextVersion(3, 2)

10.9 supports the following OpenGL versions

  • glfw::WindowHint::ContextVersion(3, 2)
  • glfw::WindowHint::ContextVersion(3, 3)
  • glfw::WindowHint::ContextVersion(4, 1)

To create an OS X compatible context, the hints should be specified as follows:

This example is not tested
glfw.window_hint(glfw::WindowHint::ContextVersion(3, 2));
glfw.window_hint(glfw::WindowHint::OpenGlForwardCompat(true));
glfw.window_hint(glfw::WindowHint::OpenGlProfile(glfw::OpenGlProfileHint::Core));

Resets the window hints previously set by the window_hint function to their default values.

Wrapper for glfwDefaultWindowHints.

Creates a new window.

Wrapper for glfwCreateWindow.

Makes the context of the specified window current. If no window is given then the current context is detached.

Wrapper for glfwMakeContextCurrent.

Wrapper for glfwGetX11Display

Immediately process the received events.

Wrapper for glfwPollEvents.

Sleep until at least one event has been received, and then perform the equivalent of Glfw::poll_events.

Wrapper for glfwWaitEvents.

Sleep until at least one event has been received, or until the specified timeout is reached, and then perform the equivalent of Glfw::poll_events. Timeout is specified in seconds.

Wrapper for glfwWaitEventsTimeout.

Posts an empty event from the current thread to the event queue, causing wait_events or wait_events_timeout to return. If no windows exist, this function returns immediately.

Wrapper for glfwPostEmptyEvent.

Returns the current value of the GLFW timer. Unless the timer has been set using glfw::set_time, the timer measures time elapsed since GLFW was initialized.

Wrapper for glfwGetTime.

Sets the value of the GLFW timer.

Wrapper for glfwSetTime.

Wrapper for glfwGetTimerValue.

Wrapper for glfwGetTimerFrequency

Sets the number of screen updates to wait before swapping the buffers of the current context and returning from Window::swap_buffers.

Wrapper for glfwSwapInterval.

Returns true if the specified OpenGL or context creation API extension is supported by the current context.

Wrapper for glfwExtensionSupported.

Returns the address of the specified client API or extension function if it is supported by the current context, NULL otherwise.

Wrapper for glfwGetProcAddress.

Constructs a Joystick handle corresponding to the supplied JoystickId.

Trait Implementations

impl Copy for Glfw
[src]

impl Clone for Glfw
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl Send for Glfw

impl Sync for Glfw