Documentation ¶
Index ¶
- Constants
- func DetachCurrentContext()
- func ExtensionSupported(extension string) bool
- func GetClipboardString() string
- func GetProcAddress(procname string) unsafe.Pointer
- func GetTime() float64
- func GetVersion() (major, minor, revision int)
- func GetVersionString() string
- func GetVulkanGetInstanceProcAddress() unsafe.Pointer
- func Init() error
- func InitHint(hint Hint, value int)
- func PollEvents()
- func PostEmptyEvent()
- func RawMouseMotionSupported() bool
- func SetClipboardString(str string)
- func SwapInterval(interval int)
- func Terminate()
- func VulkanSupported() bool
- func WaitEvents()
- func WaitEventsTimeout(timeout float64)
- func WindowHint(hint Hint, value int)
- func WindowHintString(hint Hint, value string)
- type Action
- type Application
- type Callbacks
- func (c *Callbacks) ActionAt(p f32.Point) (system.Action, bool)
- func (c *Callbacks) AppendSemanticDiffs(diffs []input.SemanticID) []input.SemanticID
- func (c *Callbacks) ClickFocus()
- func (c *Callbacks) EditorInsert(text string, preedit bool)
- func (c *Callbacks) EditorReplace(r key.Range, text string, preedit bool)
- func (c *Callbacks) EditorState() mado.EditorState
- func (c *Callbacks) Event(e event.Event) bool
- func (c *Callbacks) GetWindow() mado.Window
- func (c *Callbacks) LookupSemantic(semID input.SemanticID) (input.SemanticNode, bool)
- func (c *Callbacks) SemanticAt(pos f32.Point) (input.SemanticID, bool)
- func (c *Callbacks) SemanticRoot() input.SemanticID
- func (c *Callbacks) SetComposingRegion(r key.Range)
- func (c *Callbacks) SetDriver(d mado.Driver)
- func (c *Callbacks) SetEditorSelection(r key.Range)
- func (c *Callbacks) SetEditorSnippet(r key.Range)
- func (c *Callbacks) SetGlfwWindow(gw *Window)
- func (c *Callbacks) SetWindow(w mado.Window)
- type CharCallback
- type CharModsCallback
- type CloseCallback
- type ContentScaleCallback
- type Cursor
- type CursorEnterCallback
- type CursorPosCallback
- type DropCallback
- type Error
- type ErrorCode
- type FocusCallback
- type FramebufferSizeCallback
- type GamepadAxis
- type GamepadButton
- type GamepadState
- type GammaRamp
- type Hint
- type IconifyCallback
- type ImeStatusCallback
- type InputMode
- type Joystick
- type JoystickCallback
- type JoystickHatState
- type Key
- type KeyCallback
- type MaximizeCallback
- type ModifierKey
- type Monitor
- func (m *Monitor) GetContentScale() (float32, float32)
- func (m *Monitor) GetGammaRamp() *GammaRamp
- func (m *Monitor) GetName() string
- func (m *Monitor) GetPhysicalSize() (width, height int)
- func (m *Monitor) GetPos() (x, y int)
- func (m *Monitor) GetUserPointer() unsafe.Pointer
- func (m *Monitor) GetVideoMode() *VidMode
- func (m *Monitor) GetVideoModes() []*VidMode
- func (m *Monitor) GetWorkarea() (x, y, width, height int)
- func (m *Monitor) SetGamma(gamma float32)
- func (m *Monitor) SetGammaRamp(ramp *GammaRamp)
- func (m *Monitor) SetUserPointer(pointer unsafe.Pointer)
- type MonitorCallback
- type MouseButton
- type MouseButtonCallback
- type PeripheralEvent
- type PosCallback
- type PreeditCallback
- type PreeditCandidateCallback
- type RefreshCallback
- type ScrollCallback
- type SizeCallback
- type StandardCursor
- type VidMode
- type Window
- func (window *Window) CreateWindowSurface(instance interface{}, allocCallbacks unsafe.Pointer) (surface uintptr, err error)
- func (w *Window) Destroy()
- func (w *Window) Focus()
- func (w *Window) GetAttrib(attrib Hint) int
- func (w *Window) GetClipboardString() string
- func (w *Window) GetContentScale() (float32, float32)
- func (w *Window) GetCursorPos() (x, y float64)
- func (w *Window) GetFrameSize() (left, top, right, bottom int)
- func (w *Window) GetFramebufferSize() (width, height int)
- func (w *Window) GetInputMode(mode InputMode) int
- func (w *Window) GetMonitor() *Monitor
- func (w *Window) GetOpacity() float32
- func (w *Window) GetPos() (x, y int)
- func (window *Window) GetRequiredInstanceExtensions() []string
- func (w *Window) GetSize() (width, height int)
- func (w *Window) GetUserPointer() unsafe.Pointer
- func (w *Window) Hide()
- func (w *Window) Iconify()
- func (w *Window) MakeContextCurrent()
- func (w *Window) Maximize()
- func (w *Window) RequestAttention()
- func (w *Window) Restore()
- func (w *Window) SetAspectRatio(numer, denom int)
- func (w *Window) SetAttrib(attrib Hint, value int)
- func (w *Window) SetCharCallback(cbfun CharCallback) (previous CharCallback)
- func (w *Window) SetCharModsCallback(cbfun CharModsCallback) (previous CharModsCallback)deprecated
- func (w *Window) SetClipboardString(str string)
- func (w *Window) SetCloseCallback(cbfun CloseCallback) (previous CloseCallback)
- func (w *Window) SetContentScaleCallback(cbfun ContentScaleCallback) ContentScaleCallback
- func (w *Window) SetCursor(c *Cursor)
- func (w *Window) SetCursorEnterCallback(cbfun CursorEnterCallback) (previous CursorEnterCallback)
- func (w *Window) SetCursorPos(xpos, ypos float64)
- func (w *Window) SetCursorPosCallback(cbfun CursorPosCallback) (previous CursorPosCallback)
- func (w *Window) SetDropCallback(cbfun DropCallback) (previous DropCallback)
- func (w *Window) SetFocusCallback(cbfun FocusCallback) (previous FocusCallback)
- func (w *Window) SetFramebufferSizeCallback(cbfun FramebufferSizeCallback) (previous FramebufferSizeCallback)
- func (w *Window) SetIcon(images []image.Image)
- func (w *Window) SetIconifyCallback(cbfun IconifyCallback) (previous IconifyCallback)
- func (w *Window) SetImeStatusCallback(cbfun ImeStatusCallback) (previous ImeStatusCallback)
- func (w *Window) SetInputMode(mode InputMode, value int)
- func (w *Window) SetKeyCallback(cbfun KeyCallback) (previous KeyCallback)
- func (w *Window) SetMaximizeCallback(cbfun MaximizeCallback) MaximizeCallback
- func (w *Window) SetMonitor(monitor *Monitor, xpos, ypos, width, height, refreshRate int)
- func (w *Window) SetMouseButtonCallback(cbfun MouseButtonCallback) (previous MouseButtonCallback)
- func (w *Window) SetOpacity(opacity float32)
- func (w *Window) SetPos(xpos, ypos int)
- func (w *Window) SetPosCallback(cbfun PosCallback) (previous PosCallback)
- func (w *Window) SetPreeditCallback(cbfun PreeditCallback) (previous PreeditCallback)
- func (w *Window) SetPreeditCandidateCallback(cbfun PreeditCandidateCallback) (previous PreeditCandidateCallback)
- func (w *Window) SetRefreshCallback(cbfun RefreshCallback) (previous RefreshCallback)
- func (w *Window) SetScrollCallback(cbfun ScrollCallback) (previous ScrollCallback)
- func (w *Window) SetShouldClose(value bool)
- func (w *Window) SetSize(width, height int)
- func (w *Window) SetSizeCallback(cbfun SizeCallback) (previous SizeCallback)
- func (w *Window) SetSizeLimits(minw, minh, maxw, maxh int)
- func (w *Window) SetTitle(title string)
- func (w *Window) SetUserPointer(pointer unsafe.Pointer)
- func (w *Window) ShouldClose() bool
- func (w *Window) Show()
- func (w *Window) SwapBuffers()
Constants ¶
const ( VersionMajor = 3 // This is incremented when the API is changed in non-compatible ways. VersionMinor = 3 // This is incremented when features are added to the API but it remains backward-compatible. VersionRevision = 9 // This is incremented when a bug fix release is made that does not contain any API changes. )
Version constants.
const ( CursorNormal int = 0x00034001 CursorHidden int = 0x00034002 CursorDisabled int = 0x00034003 CursorCaptured int = 0x00034004 )
Cursor mode values.
const ( OpenGLAPI int = 0x00030001 OpenGLESAPI int = 0x00030002 NoAPI int = 0 )
Values for the ClientAPI hint.
const ( NativeContextAPI int = 0x00036001 EGLContextAPI int = 0x00036002 OSMesaContextAPI int = 0x00036003 )
Values for ContextCreationAPI hint.
const ( NoRobustness int = 0 NoResetNotification int = 0x00031001 LoseContextOnReset int = 0x00031002 )
Values for the ContextRobustness hint.
const ( AnyReleaseBehavior int = 0 ReleaseBehaviorFlush int = 0x00035001 ReleaseBehaviorNone int = 0x00035002 )
Values for ContextReleaseBehavior hint.
const ( OpenGLAnyProfile int = 0 OpenGLCoreProfile int = 0x00032001 OpenGLCompatProfile int = 0x00032002 )
Values for the OpenGLProfile hint.
const ( True int = 1 False int = 0 GlTrue int = 1 // GL_TRUE GlFalse int = 0 // GL_FALSE DontCare int = -1 )
Other values.
Variables ¶
This section is empty.
Functions ¶
func DetachCurrentContext ¶
func DetachCurrentContext()
DetachCurrentContext detaches the current context.
func ExtensionSupported ¶
ExtensionSupported reports whether the specified OpenGL or context creation API extension is supported by the current context. For example, on Windows both the OpenGL and WGL extension strings are checked.
As this functions searches one or more extension strings on each call, it is recommended that you cache its results if it's going to be used frequently. The extension strings will not change during the lifetime of a context, so there is no danger in doing this.
func GetClipboardString ¶
func GetClipboardString() string
GetClipboardString returns the contents of the system clipboard, if it contains or is convertible to a UTF-8 encoded string.
This function may only be called from the main thread.
func GetProcAddress ¶
GetProcAddress returns the address of the specified OpenGL or OpenGL ES core or extension function, if it is supported by the current context.
A context must be current on the calling thread. Calling this function without a current context will cause a GLFW_NO_CURRENT_CONTEXT error.
This function is used to provide GL proc resolving capabilities to an external C library.
func GetTime ¶
func GetTime() float64
GetTime returns the value of the GLFW timer. Unless the timer has been set using SetTime, the timer measures time elapsed since GLFW was initialized.
The resolution of the timer is system dependent, but is usually on the order of a few micro- or nanoseconds. It uses the highest-resolution monotonic time source on each supported platform.
func GetVersion ¶
func GetVersion() (major, minor, revision int)
GetVersion 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.
This function may be called before Init.
func GetVersionString ¶
func GetVersionString() string
GetVersionString returns a static string generated at compile-time according to which configuration macros were defined. This is intended for use when submitting bug reports, to allow developers to see which code paths are enabled in a binary.
This function may be called before Init.
func GetVulkanGetInstanceProcAddress ¶
GetVulkanGetInstanceProcAddress returns the function pointer used to find Vulkan core or extension functions. The return value of this function can be passed to the Vulkan library.
Note that this function does not work the same way as the glfwGetInstanceProcAddress.
func Init ¶
func Init() error
Init initializes the GLFW library. Before most GLFW functions can be used, GLFW must be initialized, and before a program terminates GLFW should be terminated in order to free any resources allocated during or after initialization.
If this function fails, it calls Terminate before returning. If it succeeds, you should call Terminate before the program exits.
Additional calls to this function after successful initialization but before termination will succeed but will do nothing.
This function may take several seconds to complete on some systems, while on other systems it may take only a fraction of a second to complete.
On Mac OS X, this function will change the current directory of the application to the Contents/Resources subdirectory of the application's bundle, if present.
This function may only be called from the main thread.
func InitHint ¶
InitHint 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.
This function must only be called from the main thread.
func PollEvents ¶
func PollEvents()
PollEvents processes only those events that have already been received and then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.
This function is not required for joystick input to work.
This function may not be called from a callback.
This function may only be called from the main thread.
func PostEmptyEvent ¶
func PostEmptyEvent()
PostEmptyEvent posts an empty event from the current thread to the main thread event queue, causing WaitEvents to return.
If no windows exist, this function returns immediately. For synchronization of threads in applications that do not create windows, use native Go primitives.
This function may be called from secondary threads.
func RawMouseMotionSupported ¶
func RawMouseMotionSupported() bool
RawMouseMotionSupported returns whether raw mouse motion is supported on the current system. This status does not change after GLFW has been initialized so you only need to check this once. If you attempt to enable raw motion on a system that does not support it, PlatformError will be emitted.
Raw mouse motion is closer to the actual motion of the mouse across a surface. It is not affected by the scaling and acceleration applied to the motion of the desktop cursor. That processing is suitable for a cursor while raw motion is better for controlling for example a 3D camera. Because of this, raw mouse motion is only provided when the cursor is disabled.
This function must only be called from the main thread.
func SetClipboardString ¶
func SetClipboardString(str string)
SetClipboardString sets the system clipboard to the specified UTF-8 encoded string.
This function may only be called from the main thread.
func SwapInterval ¶
func SwapInterval(interval int)
SwapInterval sets the swap interval for the current context, i.e. the number of screen updates to wait before swapping the buffers of a window and returning from SwapBuffers. This is sometimes called 'vertical synchronization', 'vertical retrace synchronization' or 'vsync'.
Contexts that support either of the WGL_EXT_swap_control_tear and GLX_EXT_swap_control_tear extensions also accept negative swap intervals, which allow the driver to swap even if a frame arrives a little bit late. You can check for the presence of these extensions using ExtensionSupported. For more information about swap tearing, see the extension specifications.
Some GPU drivers do not honor the requested swap interval, either because of user settings that override the request or due to bugs in the driver.
func Terminate ¶
func Terminate()
Terminate destroys all remaining windows, frees any allocated resources and sets the library to an uninitialized state. Once this is called, you must again call Init successfully before you will be able to use most GLFW functions.
If GLFW has been successfully initialized, this function should be called before the program exits. If initialization fails, there is no need to call this function, as it is called by Init before it returns failure.
This function may only be called from the main thread.
func VulkanSupported ¶
func VulkanSupported() bool
VulkanSupported reports whether the Vulkan loader has been found. This check is performed by Init.
The availability of a Vulkan loader does not by itself guarantee that window surface creation or even device creation is possible. Call GetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan surface creation are available and GetPhysicalDevicePresentationSupport to check whether a queue family of a physical device supports image presentation.
func WaitEvents ¶
func WaitEvents()
WaitEvents puts the calling thread to sleep until at least one event has been received. Once one or more events have been recevied, it behaves as if PollEvents was called, i.e. the events are processed and the function then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.
Since not all events are associated with callbacks, this function may return without a callback having been called even if you are monitoring all callbacks.
This function may not be called from a callback.
This function may only be called from the main thread.
func WaitEventsTimeout ¶
func WaitEventsTimeout(timeout float64)
WaitEventsTimeout puts the calling thread to sleep until at least one event is available in the event queue, or until the specified timeout is reached. If one or more events are available, it behaves exactly like PollEvents, i.e. the events in the queue are processed and the function then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.
The timeout value must be a positive finite number.
Since not all events are associated with callbacks, this function may return without a callback having been called even if you are monitoring all callbacks.
On some platforms, a window move, resize or menu operation will cause event processing to block. This is due to how event processing is designed on those platforms. You can use the window refresh callback to redraw the contents of your window when necessary during such operations.
On some platforms, certain callbacks may be called outside of a call to one of the event processing functions.
If no windows exist, this function returns immediately. For synchronization of threads in applications that do not create windows, use native Go primitives.
Event processing is not required for joystick input to work.
func WindowHint ¶
WindowHint sets hints for the next call to CreateWindow. The hints, once set, retain their values until changed by a call to WindowHint or DefaultWindowHints, or until the library is terminated with Terminate.
This function may only be called from the main thread.
func WindowHintString ¶
WindowHintString sets hints for the next call to CreateWindow. The hints, once set, retain their values until changed by a call to this function or DefaultWindowHints, or until the library is terminated.
Only string type hints can be set with this function. Integer value hints are set with WindowHint.
This function does not check whether the specified hint values are valid. If you set hints to invalid values this will instead be reported by the next call to CreateWindow.
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.
This function must only be called from the main thread.
Types ¶
type Application ¶
type Application struct { // Context is used to broadcast application shutdown. // Context context.Context // Stop context.CancelFunc Ctx mado.Context MainWindow *Window // // Shutdown shuts down all windows. // Shutdown func() // active keeps track the open windows, such that application // can shut down, when all of them are closed. Active sync.WaitGroup // contains filtered or unexported fields }
Application keeps track of all the windows and global state.
func NewApplication ¶
func NewApplication() *Application
func NewApplication(ctx context.Context, stop context.CancelFunc) *Application {
type Callbacks ¶
type Callbacks struct { W *app.Window Gw *Window D mado.Driver Busy bool PrevWindowMode mado.WindowMode PrevWindowStage mado.Stage PrevScaling f32.Point PrevWindowSize image.Point PrevFramebufferSize image.Point PrevCursorPos f32.Point PrevModifiers key.Modifiers Preedit string WaitEvents []event.Event WindowInitialized chan struct{} }
func (*Callbacks) AppendSemanticDiffs ¶
func (c *Callbacks) AppendSemanticDiffs(diffs []input.SemanticID) []input.SemanticID
func (*Callbacks) ClickFocus ¶
func (c *Callbacks) ClickFocus()
func (*Callbacks) EditorInsert ¶
func (*Callbacks) EditorReplace ¶
func (*Callbacks) EditorState ¶
func (c *Callbacks) EditorState() mado.EditorState
func (*Callbacks) LookupSemantic ¶
func (c *Callbacks) LookupSemantic(semID input.SemanticID) (input.SemanticNode, bool)
LookupSemantic looks up a semantic node from an ID. The zero ID denotes the root.
func (*Callbacks) SemanticAt ¶
func (*Callbacks) SemanticRoot ¶
func (c *Callbacks) SemanticRoot() input.SemanticID
SemanticRoot returns the ID of the semantic root.
func (*Callbacks) SetComposingRegion ¶
func (*Callbacks) SetEditorSelection ¶
func (*Callbacks) SetEditorSnippet ¶
func (*Callbacks) SetGlfwWindow ¶
type CharCallback ¶
CharCallback is the character callback.
type CharModsCallback ¶
type CharModsCallback func(w *Window, char rune, mods ModifierKey)
CharModsCallback is the character with modifiers callback.
type ContentScaleCallback ¶
ContentScaleCallback is the function signature for window content scale callback functions.
type Cursor ¶
type Cursor struct{}
Cursor represents a cursor.
func CreateCursor ¶
CreateCursor creates a new custom cursor image that can be set for a window with SetCursor. The cursor can be destroyed with Destroy. Any remaining cursors are destroyed by Terminate.
The image is ideally provided in the form of *image.NRGBA. The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. They are arranged canonically as packed sequential rows, starting from the top-left corner. If the image type is not *image.NRGBA, it will be converted to it.
The cursor hotspot is specified in pixels, relative to the upper-left corner of the cursor image. Like all other coordinate systems in GLFW, the X-axis points to the right and the Y-axis points down.
func CreateStandardCursor ¶
func CreateStandardCursor(shape StandardCursor) *Cursor
CreateStandardCursor returns a cursor with a standard shape, that can be set for a window with SetCursor.
type CursorEnterCallback ¶
CursorEnterCallback is the cursor boundary crossing callback.
type CursorPosCallback ¶
CursorPosCallback the cursor position callback.
type DropCallback ¶
DropCallback is the drop callback.
type ErrorCode ¶
type ErrorCode int
ErrorCode corresponds to an error code.
const ( // for the requested client API on the system. // // The installed graphics driver does not support the requested client API, // or does not support it via the chosen context creation backend. Below // are a few examples. // // Some pre-installed Windows graphics drivers do not support OpenGL. AMD // only supports OpenGL ES via EGL, while Nvidia and Intel only supports it // via a WGL or GLX extension. OS X does not provide OpenGL ES at all. The // Mesa EGL, OpenGL and OpenGL ES libraries do not interface with the // Nvidia binary driver. APIUnavailable ErrorCode = apiUnavailable // OpenGL ES (including any requested profile or context option) is not // available on this machine. // // The machine does not support your requirements. If your application is // sufficiently flexible, downgrade your requirements and try again. // Otherwise, inform the user that their machine does not match your // requirements. // // Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if // 5.0 comes out before the 4.x series gets that far, also fail with this // error and not GLFW_INVALID_VALUE, because GLFW cannot know what future // versions will exist. VersionUnavailable ErrorCode = versionUnavailable // clipboard querying format errors. // // If emitted during window creation, the requested pixel format is not // supported. This means one or more hard constraints did not match any of // the available pixel formats. If your application is sufficiently // flexible, downgrade your requirements and try again. Otherwise, inform // the user that their machine does not match your requirements. // // If emitted when querying the clipboard, the contents of the clipboard // could not be converted to the requested format. You should ignore the // error or report it to the user, as appropriate. FormatUnavailable ErrorCode = formatUnavailable )
type FocusCallback ¶
FocusCallback is the window focus callback.
type FramebufferSizeCallback ¶
FramebufferSizeCallback is the framebuffer size callback.
type GamepadAxis ¶
type GamepadAxis int
GamepadAxis corresponds to a gamepad axis.
const ( AxisLeftX GamepadAxis = 0 AxisLeftY GamepadAxis = 1 AxisRightX GamepadAxis = 2 AxisRightY GamepadAxis = 3 AxisLeftTrigger GamepadAxis = 4 AxisRightTrigger GamepadAxis = 5 AxisLast GamepadAxis = AxisRightTrigger )
Gamepad axis IDs.
type GamepadButton ¶
type GamepadButton int
GamepadButton corresponds to a gamepad button.
const ( ButtonA GamepadButton = 0 ButtonB GamepadButton = 1 ButtonX GamepadButton = 2 ButtonY GamepadButton = 3 ButtonLeftBumper GamepadButton = 4 ButtonRightBumper GamepadButton = 5 ButtonBack GamepadButton = 6 ButtonStart GamepadButton = 7 ButtonGuide GamepadButton = 8 ButtonLeftThumb GamepadButton = 9 ButtonRightThumb GamepadButton = 10 ButtonDpadUp GamepadButton = 11 ButtonDpadRight GamepadButton = 12 ButtonDpadDown GamepadButton = 13 ButtonDpadLeft GamepadButton = 14 ButtonLast GamepadButton = ButtonDpadLeft ButtonCross GamepadButton = ButtonA ButtonCircle GamepadButton = ButtonB ButtonSquare GamepadButton = ButtonX ButtonTriangle GamepadButton = ButtonY )
Gamepad button IDs.
type GamepadState ¶
GamepadState describes the input state of a gamepad.
type GammaRamp ¶
type GammaRamp struct { Red []uint16 // A slice of value describing the response of the red channel. Green []uint16 // A slice of value describing the response of the green channel. Blue []uint16 // A slice of value describing the response of the blue channel. }
GammaRamp describes the gamma ramp for a monitor.
type Hint ¶
type Hint int
Hint corresponds to hints that can be set before creating a window.
Hint also corresponds to the attributes of the window that can be get after its creation.
const ( JoystickHatButtons Hint = 0x00050001 // Specifies whether to also expose joystick hats as buttons, for compatibility with earlier versions of GLFW that did not have glfwGetJoystickHats. CocoaChdirResources Hint = 0x00051001 // Specifies whether to set the current directory to the application to the Contents/Resources subdirectory of the application's bundle, if present. CocoaMenubar Hint = 0x00051002 // Specifies whether to create a basic menu bar, either from a nib or manually, when the first window is created, which is when AppKit is initialized. WaylandLibdecor Hint = 0x00053001 // Wayland specific init hint. )
Init related hints. (Use with glfw.InitHint)
const ( Focused Hint = 0x00020001 // Specifies whether the window will be given input focus when created. This hint is ignored for full screen and initially hidden windows. Iconified Hint = 0x00020002 // Specifies whether the window will be minimized. Resizable Hint = 0x00020003 // Specifies whether the window will be resizable by the user. Visible Hint = 0x00020004 // Specifies whether the window will be initially visible. Decorated Hint = 0x00020005 // Specifies whether the window will have window decorations such as a border, a close widget, etc. AutoIconify Hint = 0x00020006 // Specifies whether fullscreen windows automatically iconify (and restore the previous video mode) on focus loss. Floating Hint = 0x00020007 // Specifies whether the window will be always-on-top. Maximized Hint = 0x00020008 // Specifies whether the window is maximized. CenterCursor Hint = 0x00020009 // Specifies whether the cursor should be centered over newly created full screen windows. This hint is ignored for windowed mode windows. TransparentFramebuffer Hint = 0x0002000A // Specifies whether the framebuffer should be transparent. Hovered Hint = 0x0002000B // Specifies whether the cursor is currently directly over the content area of the window, with no other windows between. See Cursor enter/leave events for details. FocusOnShow Hint = 0x0002000C // Specifies whether the window will be given input focus when glfwShowWindow is called. )
Window related hints/attributes.
const ( ClientAPI Hint = 0x00022001 // Specifies which client API to create the context for. Hard constraint. ContextVersionMajor Hint = 0x00022002 // Specifies the client API version that the created context must be compatible with. ContextVersionMinor Hint = 0x00022003 // Specifies the client API version that the created context must be compatible with. ContextRevision Hint = 0x00022004 // Context client API revision number attribute. ContextRobustness Hint = 0x00022005 // Specifies the robustness strategy to be used by the context. OpenGLForwardCompatible Hint = 0x00022006 // Specifies whether the OpenGL context should be forward-compatible. Hard constraint. OpenGLDebugContext Hint = 0x00022007 // Specifies whether to create a debug OpenGL context, which may have additional error and performance issue reporting functionality. If OpenGL ES is requested, this hint is ignored. OpenGLProfile Hint = 0x00022008 // Specifies which OpenGL profile to create the context for. Hard constraint. ContextReleaseBehavior Hint = 0x00022009 // Specifies the release behavior to be used by the context. ContextNoError Hint = 0x0002200A // Context error suppression hint and attribute. ContextCreationAPI Hint = 0x0002200B // Specifies which context creation API to use to create the context. ScaleToMonitor Hint = 0x0002200C // Specified whether the window content area should be resized based on the monitor content scale of any monitor it is placed on. This includes the initial placement when the window is created. )
Context related hints.
const ( RedBits Hint = 0x00021001 // Specifies the desired bit depth of the default framebuffer. GreenBits Hint = 0x00021002 // Specifies the desired bit depth of the default framebuffer. BlueBits Hint = 0x00021003 // Specifies the desired bit depth of the default framebuffer. AlphaBits Hint = 0x00021004 // Specifies the desired bit depth of the default framebuffer. DepthBits Hint = 0x00021005 // Specifies the desired bit depth of the default framebuffer. StencilBits Hint = 0x00021006 // Specifies the desired bit depth of the default framebuffer. AccumRedBits Hint = 0x00021007 // Specifies the desired bit depth of the accumulation buffer. AccumGreenBits Hint = 0x00021008 // Specifies the desired bit depth of the accumulation buffer. AccumBlueBits Hint = 0x00021009 // Specifies the desired bit depth of the accumulation buffer. AccumAlphaBits Hint = 0x0002100A // Specifies the desired bit depth of the accumulation buffer. AuxBuffers Hint = 0x0002100B // Specifies the desired number of auxiliary buffers. Stereo Hint = 0x0002100C // Specifies whether to use stereoscopic rendering. Hard constraint. Samples Hint = 0x0002100D // Specifies the desired number of samples to use for multisampling. Zero disables multisampling. SRGBCapable Hint = 0x0002100E // Specifies whether the framebuffer should be sRGB capable. RefreshRate Hint = 0x0002100F // Specifies the desired refresh rate for full screen windows. If set to zero, the highest available refresh rate will be used. This hint is ignored for windowed mode windows. DoubleBuffer Hint = 0x00021010 // Specifies whether the framebuffer should be double buffered. You nearly always want to use double buffering. This is a hard constraint. CocoaRetinaFramebuffer Hint = 0x00023001 // Specifies whether to use full resolution framebuffers on Retina displays. CocoaGraphicsSwitching Hint = 0x00023003 // Specifies whether to in Automatic Graphics Switching, i.e. to allow the system to choose the integrated GPU for the OpenGL context and move it between GPUs if necessary or whether to force it to always run on the discrete GPU. )
Framebuffer related hints.
const ( CocoaFrameNAME Hint = 0x00023002 // Specifies the UTF-8 encoded name to use for autosaving the window frame, or if empty disables frame autosaving for the window. X11ClassName Hint = 0x00024001 // Specifies the desired ASCII encoded class parts of the ICCCM WM_CLASS window property.nd instance parts of the ICCCM WM_CLASS window property. X11InstanceName Hint = 0x00024002 // Specifies the desired ASCII encoded instance parts of the ICCCM WM_CLASS window property.nd instance parts of the ICCCM WM_CLASS window property. )
Naming related hints. (Use with glfw.WindowHintString)
type IconifyCallback ¶
IconifyCallback is the window iconification callback.
type ImeStatusCallback ¶
type ImeStatusCallback func(w *Window)
ImeStatusCallback is change signal of the Ime status to the window callback.
type InputMode ¶
type InputMode int
InputMode corresponds to an input mode.
const ( CursorMode InputMode = 0x00033001 // See Cursor mode values StickyKeysMode InputMode = 0x00033002 // Value can be either 1 or 0 StickyMouseButtonsMode InputMode = 0x00033003 // Value can be either 1 or 0 LockKeyMods InputMode = 0x00033004 // Value can be either 1 or 0 RawMouseMotion InputMode = 0x00033005 // Value can be either 1 or 0 Ime InputMode = 0x00033006 // Value can be either 1 or 0 ImeOwnerDraw InputMode = 0x00033011 // Value can be either 1 or 0 )
Input modes.
type Joystick ¶
type Joystick int
Joystick corresponds to a joystick.
const ( Joystick1 Joystick = 0 Joystick2 Joystick = 1 Joystick3 Joystick = 2 Joystick4 Joystick = 3 Joystick5 Joystick = 4 Joystick6 Joystick = 5 Joystick7 Joystick = 6 Joystick8 Joystick = 7 Joystick9 Joystick = 8 Joystick10 Joystick = 9 Joystick11 Joystick = 10 Joystick12 Joystick = 11 Joystick13 Joystick = 12 Joystick14 Joystick = 13 Joystick15 Joystick = 14 Joystick16 Joystick = 15 JoystickLast Joystick = Joystick16 )
Joystick IDs.
type JoystickCallback ¶
type JoystickCallback func(joy Joystick, event PeripheralEvent)
JoystickCallback is the joystick configuration callback.
func SetJoystickCallback ¶
func SetJoystickCallback(cbfun JoystickCallback) (previous JoystickCallback)
SetJoystickCallback sets the joystick configuration callback, or removes the currently set callback. This is called when a joystick is connected to or disconnected from the system.
type JoystickHatState ¶
type JoystickHatState int
JoystickHatState corresponds to joystick hat states.
const ( HatCentered JoystickHatState = 0 HatUp JoystickHatState = 1 HatRight JoystickHatState = 2 HatDown JoystickHatState = 4 HatLeft JoystickHatState = 8 HatRightUp JoystickHatState = (HatRight | HatUp) HatRightDown JoystickHatState = (HatRight | HatDown) HatLeftUp JoystickHatState = (HatLeft | HatUp) HatLeftDown JoystickHatState = (HatLeft | HatDown) )
Joystick Hat State IDs.
type Key ¶
type Key int
Key corresponds to a keyboard key.
const ( KeyUnknown Key = -1 KeySpace Key = 32 KeyApostrophe Key = 39 /* ' */ KeyComma Key = 44 /* , */ KeyMinus Key = 45 /* - */ KeyPeriod Key = 46 /* . */ KeySlash Key = 47 /* / */ Key0 Key = 48 Key1 Key = 49 Key2 Key = 50 Key3 Key = 51 Key4 Key = 52 Key5 Key = 53 Key6 Key = 54 Key7 Key = 55 Key8 Key = 56 Key9 Key = 57 KeySemicolon Key = 59 /* ; */ KeyEqual Key = 61 /* = */ KeyA Key = 65 KeyB Key = 66 KeyC Key = 67 KeyD Key = 68 KeyE Key = 69 KeyF Key = 70 KeyG Key = 71 KeyH Key = 72 KeyI Key = 73 KeyJ Key = 74 KeyK Key = 75 KeyL Key = 76 KeyM Key = 77 KeyN Key = 78 KeyO Key = 79 KeyP Key = 80 KeyQ Key = 81 KeyR Key = 82 KeyS Key = 83 KeyT Key = 84 KeyU Key = 85 KeyV Key = 86 KeyW Key = 87 KeyX Key = 88 KeyY Key = 89 KeyZ Key = 90 KeyLeftBracket Key = 91 /* [ */ KeyBackslash Key = 92 /* \ */ KeyRightBracket Key = 93 /* ] */ KeyGraveAccent Key = 96 /* ` */ KeyWorld1 Key = 161 /* non-US #1 */ KeyWorld2 Key = 162 /* non-US #2 */ KeyEscape Key = 256 KeyEnter Key = 257 KeyTab Key = 258 KeyBackspace Key = 259 KeyInsert Key = 260 KeyDelete Key = 261 KeyRight Key = 262 KeyLeft Key = 263 KeyDown Key = 264 KeyUp Key = 265 KeyPageUp Key = 266 KeyPageDown Key = 267 KeyHome Key = 268 KeyEnd Key = 269 KeyCapsLock Key = 280 KeyScrollLock Key = 281 KeyNumLock Key = 282 KeyPrintScreen Key = 283 KeyPause Key = 284 KeyF1 Key = 290 KeyF2 Key = 291 KeyF3 Key = 292 KeyF4 Key = 293 KeyF5 Key = 294 KeyF6 Key = 295 KeyF7 Key = 296 KeyF8 Key = 297 KeyF9 Key = 298 KeyF10 Key = 299 KeyF11 Key = 300 KeyF12 Key = 301 KeyF13 Key = 302 KeyF14 Key = 303 KeyF15 Key = 304 KeyF16 Key = 305 KeyF17 Key = 306 KeyF18 Key = 307 KeyF19 Key = 308 KeyF20 Key = 309 KeyF21 Key = 310 KeyF22 Key = 311 KeyF23 Key = 312 KeyF24 Key = 313 KeyF25 Key = 314 KeyKP0 Key = 320 KeyKP1 Key = 321 KeyKP2 Key = 322 KeyKP3 Key = 323 KeyKP4 Key = 324 KeyKP5 Key = 325 KeyKP6 Key = 326 KeyKP7 Key = 327 KeyKP8 Key = 328 KeyKP9 Key = 329 KeyKPDecimal Key = 330 KeyKPDivide Key = 331 KeyKPMultiply Key = 332 KeyKPSubtract Key = 333 KeyKPAdd Key = 334 KeyKPEnter Key = 335 KeyKPEqual Key = 336 KeyLeftShift Key = 340 KeyLeftControl Key = 341 KeyLeftAlt Key = 342 KeyLeftSuper Key = 343 KeyRightShift Key = 344 KeyRightControl Key = 345 KeyRightAlt Key = 346 KeyRightSuper Key = 347 KeyMenu Key = 348 KeyLast Key = KeyMenu )
These key codes are inspired by the USB HID Usage Tables v1.12 (p. 53-60), but re-arranged to map to 7-bit ASCII for printable keys (function keys are put in the 256+ range).
type KeyCallback ¶
type KeyCallback func(w *Window, key Key, scancode int, action Action, mods ModifierKey)
KeyCallback is the key callback.
type MaximizeCallback ¶
MaximizeCallback is the function signature for window maximize callback functions.
type ModifierKey ¶
type ModifierKey int
ModifierKey corresponds to a modifier key.
const ( ModShift ModifierKey = 0x0001 ModControl ModifierKey = 0x0002 ModAlt ModifierKey = 0x0004 ModSuper ModifierKey = 0x0008 ModCapsLock ModifierKey = 0x0010 ModNumLock ModifierKey = 0x0020 )
Modifier keys.
type Monitor ¶
type Monitor struct { }
Monitor represents a monitor.
func GetMonitors ¶
func GetMonitors() []*Monitor
GetMonitors returns a slice of handles for all currently connected monitors.
func GetPrimaryMonitor ¶
func GetPrimaryMonitor() *Monitor
GetPrimaryMonitor returns the primary monitor. This is usually the monitor where elements like the Windows task bar or the OS X menu bar is located.
func (*Monitor) GetContentScale ¶
GetContentScale function retrieves the content scale for the specified monitor. The content scale is the ratio between the current DPI and the platform's default DPI. If you scale all pixel dimensions by this scale then your content should appear at an appropriate size. This is especially important for text and any UI elements.
This function must only be called from the main thread.
func (*Monitor) GetGammaRamp ¶
GetGammaRamp retrieves the current gamma ramp of the monitor.
func (*Monitor) GetPhysicalSize ¶
GetPhysicalSize returns the size, in millimetres, of the display area of the monitor.
Note: Some operating systems do not provide accurate information, either because the monitor's EDID data is incorrect, or because the driver does not report it accurately.
func (*Monitor) GetPos ¶
GetPos returns the position, in screen coordinates, of the upper-left corner of the monitor.
func (*Monitor) GetUserPointer ¶
GetUserPointer returns the current value of the user-defined pointer of the monitor. The initial value is nil.
This function may be called from the monitor callback, even for a monitor that is being disconnected.
This function may be called from any thread. Access is not synchronized.
func (*Monitor) GetVideoMode ¶
GetVideoMode returns the current video mode of the monitor. If you are using a full screen window, the return value will therefore depend on whether it is focused.
func (*Monitor) GetVideoModes ¶
GetVideoModes returns an array of all video modes supported by the monitor. The returned array is sorted in ascending order, first by color bit depth (the sum of all channel depths) and then by resolution area (the product of width and height).
func (*Monitor) GetWorkarea ¶
GetWorkarea returns the position, in screen coordinates, of the upper-left corner of the work area of the specified monitor along with the work area size in screen coordinates. The work area is defined as the area of the monitor not occluded by the operating system task bar where present. If no task bar exists then the work area is the monitor resolution in screen coordinates.
This function must only be called from the main thread.
func (*Monitor) SetGamma ¶
SetGamma generates a 256-element gamma ramp from the specified exponent and then calls SetGamma with it.
func (*Monitor) SetGammaRamp ¶
SetGammaRamp sets the current gamma ramp for the monitor.
func (*Monitor) SetUserPointer ¶
SetUserPointer sets the user-defined pointer of the monitor. The current value is retained until the monitor is disconnected. The initial value is nil.
This function may be called from the monitor callback, even for a monitor that is being disconnected.
This function may be called from any thread. Access is not synchronized.
type MonitorCallback ¶
type MonitorCallback func(monitor *Monitor, event PeripheralEvent)
MonitorCallback is the signature for monitor configuration callback functions.
func SetMonitorCallback ¶
func SetMonitorCallback(cbfun MonitorCallback) MonitorCallback
SetMonitorCallback sets the monitor configuration callback, or removes the currently set callback. This is called when a monitor is connected to or disconnected from the system.
This function must only be called from the main thread.
type MouseButton ¶
type MouseButton int
MouseButton corresponds to a mouse button.
const ( MouseButton1 MouseButton = 0 MouseButton2 MouseButton = 1 MouseButton3 MouseButton = 2 MouseButton4 MouseButton = 3 MouseButton5 MouseButton = 4 MouseButton6 MouseButton = 5 MouseButton7 MouseButton = 6 MouseButton8 MouseButton = 7 MouseButtonLast MouseButton = MouseButton8 MouseButtonLeft MouseButton = MouseButton1 MouseButtonRight MouseButton = MouseButton2 MouseButtonMiddle MouseButton = MouseButton3 )
Mouse buttons.
type MouseButtonCallback ¶
type MouseButtonCallback func(w *Window, button MouseButton, action Action, mods ModifierKey)
MouseButtonCallback is the mouse button callback.
type PeripheralEvent ¶
type PeripheralEvent int
PeripheralEvent corresponds to a peripheral(Monitor or Joystick) configuration event.
const ( Connected PeripheralEvent = 0x00040001 Disconnected PeripheralEvent = 0x00040002 )
PeripheralEvent events.
type PosCallback ¶
PosCallback is the window position callback.
type PreeditCallback ¶
type PreeditCallback func( w *Window, preeditCount int, preeditString string, blockCount int, blockSizes string, focusedBlock int, caret int, )
PreeditCallback is preedit text input callback.
type PreeditCandidateCallback ¶
type PreeditCandidateCallback func( w *Window, candidatesCount int, selectedIndex int, pageStart int, pageSize int, )
PreeditCandidateCallback is change signal of the Ime status to the window callback.
type RefreshCallback ¶
type RefreshCallback func(w *Window)
RefreshCallback is the window refresh callback.
type ScrollCallback ¶
ScrollCallback is the scroll callback.
type SizeCallback ¶
SizeCallback is the window size callback.
type StandardCursor ¶
type StandardCursor int
StandardCursor corresponds to a standard cursor icon.
const ( ArrowCursor StandardCursor = 0x00036001 IBeamCursor StandardCursor = 0x00036002 CrosshairCursor StandardCursor = 0x00036003 HandCursor StandardCursor = 0x00036004 HResizeCursor StandardCursor = 0x00036005 VResizeCursor StandardCursor = 0x00036006 )
Standard cursors
type VidMode ¶
type VidMode struct { Width int // The width, in pixels, of the video mode. Height int // The height, in pixels, of the video mode. RedBits int // The bit depth of the red channel of the video mode. GreenBits int // The bit depth of the green channel of the video mode. BlueBits int // The bit depth of the blue channel of the video mode. RefreshRate int // The refresh rate, in Hz, of the video mode. }
VidMode describes a single video mode.
type Window ¶
type Window struct { App *Application // contains filtered or unexported fields }
Window represents a window.
func CreateWindow ¶
func CreateWindow(width, height int, title string, monitor *Monitor, share *Window) (*Window, error)
CreateWindow creates a window and its associated context. Most of the options controlling how the window and its context should be created are specified through Hint.
Successful creation does not change which context is current. Before you can use the newly created context, you need to make it current using MakeContextCurrent.
Note that the created window and context may differ from what you requested, as not all parameters and hints are hard constraints. This includes the size of the window, especially for full screen windows. To retrieve the actual attributes of the created window and context, use queries like Window.GetAttrib and Window.GetSize.
To create the window at a specific position, make it initially invisible using the Visible window hint, set its position and then show it.
If a fullscreen window is active, the screensaver is prohibited from starting.
Windows: If the executable has an icon resource named GLFW_ICON, it will be set as the icon for the window. If no such icon is present, the IDI_WINLOGO icon will be used instead.
Mac OS X: The GLFW window has no icon, as it is not a document window, but the dock icon will be the same as the application bundle's icon. Also, the first time a window is opened the menu bar is populated with common commands like Hide, Quit and About. The (minimal) about dialog uses information from the application's bundle. For more information on bundles, see the Bundle Programming Guide provided by Apple.
This function may only be called from the main thread.
func GetCurrentContext ¶
func GetCurrentContext() *Window
GetCurrentContext returns the window whose context is current.
func (*Window) CreateWindowSurface ¶
func (window *Window) CreateWindowSurface(instance interface{}, allocCallbacks unsafe.Pointer) (surface uintptr, err error)
CreateWindowSurface creates a Vulkan surface for this window.
func (*Window) Destroy ¶
func (w *Window) Destroy()
Destroy destroys the specified window and its context. On calling this function, no further callbacks will be called for that window.
This function may only be called from the main thread.
func (*Window) Focus ¶
func (w *Window) Focus()
Focus brings the specified window to front and sets input focus. The window should already be visible and not iconified.
By default, both windowed and full screen mode windows are focused when initially created. Set the glfw.Focused to disable this behavior.
Do not use this function to steal focus from other applications unless you are certain that is what the user wants. Focus stealing can be extremely disruptive.
func (*Window) GetAttrib ¶
GetAttrib returns an attribute of the window. There are many attributes, some related to the window and others to its context.
func (*Window) GetClipboardString ¶
GetClipboardString returns the contents of the system clipboard, if it contains or is convertible to a UTF-8 encoded string.
Ownership to the Window is no longer necessary, see glfw.GetClipboardString()
This function may only be called from the main thread.
func (*Window) GetContentScale ¶
GetContentScale function retrieves the content scale for the specified window. The content scale is the ratio between the current DPI and the platform's default DPI. If you scale all pixel dimensions by this scale then your content should appear at an appropriate size. This is especially important for text and any UI elements.
This function may only be called from the main thread.
func (*Window) GetCursorPos ¶
GetCursorPos returns the last reported position of the cursor.
If the cursor is disabled (with CursorDisabled) then the cursor position is unbounded and limited only by the minimum and maximum values of a double.
The coordinate can be converted to their integer equivalents with the floor function. Casting directly to an integer type works for positive coordinates, but fails for negative ones.
func (*Window) GetFrameSize ¶
GetFrameSize retrieves the size, in screen coordinates, of each edge of the frame of the specified window. This size includes the title bar, if the window has one. The size of the frame may vary depending on the window-related hints used to create it.
Because this function retrieves the size of each window frame edge and not the offset along a particular coordinate axis, the retrieved values will always be zero or positive.
func (*Window) GetFramebufferSize ¶
GetFramebufferSize retrieves the size, in pixels, of the framebuffer of the specified window.
func (*Window) GetInputMode ¶
GetInputMode returns the value of an input option of the window.
func (*Window) GetMonitor ¶
GetMonitor returns the handle of the monitor that the window is in fullscreen on.
Returns nil if the window is in windowed mode.
func (*Window) GetOpacity ¶
GetOpacity function returns the opacity of the window, including any decorations.
The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque. If the system does not support whole window transparency, this function always returns one.
The initial opacity value for newly created windows is one.
This function may only be called from the main thread.
func (*Window) GetPos ¶
GetPos returns the position, in screen coordinates, of the upper-left corner of the client area of the window.
func (*Window) GetRequiredInstanceExtensions ¶
GetRequiredInstanceExtensions returns a slice of Vulkan instance extension names required by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the list will always contain VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.
If Vulkan is not available on the machine, this function returns nil. Call VulkanSupported to check whether Vulkan is available.
If Vulkan is available but no set of extensions allowing window surface creation was found, this function returns nil. You may still use Vulkan for off-screen rendering and compute work.
func (*Window) GetSize ¶
GetSize returns the size, in screen coordinates, of the client area of the specified window.
func (*Window) GetUserPointer ¶
GetUserPointer returns the current value of the user-defined pointer of the window. The initial value is nil.
func (*Window) Hide ¶
func (w *Window) Hide()
Hide hides the window, if it was previously visible. If the window is already hidden or is in full screen mode, this function does nothing.
This function may only be called from the main thread.
func (*Window) Iconify ¶
func (w *Window) Iconify()
Iconify iconifies/minimizes the window, if it was previously restored. If it is a full screen window, the original monitor resolution is restored until the window is restored. If the window is already iconified, this function does nothing.
This function may only be called from the main thread.
func (*Window) MakeContextCurrent ¶
func (w *Window) MakeContextCurrent()
func (*Window) Maximize ¶
func (w *Window) Maximize()
Maximize maximizes the specified window if it was previously not maximized. If the window is already maximized, this function does nothing.
If the specified window is a full screen window, this function does nothing.
func (*Window) RequestAttention ¶
func (w *Window) RequestAttention()
RequestWindowAttention funciton requests user attention to the specified window. On platforms where this is not supported, attention is requested to the application as a whole.
Once the user has given attention, usually by focusing the window or application, the system will end the request automatically.
This function must only be called from the main thread.
func (*Window) Restore ¶
func (w *Window) Restore()
Restore restores the window, if it was previously iconified/minimized. If it is a full screen window, the resolution chosen for the window is restored on the selected monitor. If the window is already restored, this function does nothing.
This function may only be called from the main thread.
func (*Window) SetAspectRatio ¶
SetAspectRatio sets the required aspect ratio of the client area of the specified window. If the window is full screen or not resizable, this function does nothing.
The aspect ratio is specified as a numerator and a denominator and both values must be greater than zero. For example, the common 16:9 aspect ratio is specified as 16 and 9, respectively.
If the numerator and denominator is set to glfw.DontCare then the aspect ratio limit is disabled.
The aspect ratio is applied immediately and may cause the window to be resized.
func (*Window) SetAttrib ¶
SetAttrib function sets the value of an attribute of the specified window.
The supported attributes are Decorated, Resizeable, Floating and AutoIconify.
Some of these attributes are ignored for full screen windows. The new value will take effect if the window is later made windowed.
Some of these attributes are ignored for windowed mode windows. The new value will take effect if the window is later made full screen.
This function may only be called from the main thread.
func (*Window) SetCharCallback ¶
func (w *Window) SetCharCallback(cbfun CharCallback) (previous CharCallback)
SetCharCallback sets the character callback which is called when a Unicode character is input.
The character callback is intended for Unicode text input. As it deals with characters, it is keyboard layout dependent, whereas the key callback is not. Characters do not map 1:1 to physical keys, as a key may produce zero, one or more characters. If you want to know whether a specific physical key was pressed or released, see the key callback instead.
The character callback behaves as system text input normally does and will not be called if modifier keys are held down that would prevent normal text input on that platform, for example a Super (Command) key on OS X or Alt key on Windows. There is a character with modifiers callback that receives these events.
func (*Window) SetCharModsCallback
deprecated
func (w *Window) SetCharModsCallback(cbfun CharModsCallback) (previous CharModsCallback)
SetCharModsCallback sets the character with modifiers callback which is called when a Unicode character is input regardless of what modifier keys are used.
Deprecated: Scheduled for removal in version 4.0.
The character with modifiers callback is intended for implementing custom Unicode character input. For regular Unicode text input, see the character callback. Like the character callback, the character with modifiers callback deals with characters and is keyboard layout dependent. Characters do not map 1:1 to physical keys, as a key may produce zero, one or more characters. If you want to know whether a specific physical key was pressed or released, see the key callback instead.
func (*Window) SetClipboardString ¶
SetClipboardString sets the system clipboard to the specified UTF-8 encoded string.
Ownership to the Window is no longer necessary, see glfw.SetClipboardString(string)
This function may only be called from the main thread.
func (*Window) SetCloseCallback ¶
func (w *Window) SetCloseCallback(cbfun CloseCallback) (previous CloseCallback)
SetCloseCallback sets the close callback of the window, which is called when the user attempts to close the window, for example by clicking the close widget in the title bar.
The close flag is set before this callback is called, but you can modify it at any time with SetShouldClose.
Mac OS X: Selecting Quit from the application menu will trigger the close callback for all windows.
func (*Window) SetContentScaleCallback ¶
func (w *Window) SetContentScaleCallback(cbfun ContentScaleCallback) ContentScaleCallback
SetContentScaleCallback function sets the window content scale callback of the specified window, which is called when the content scale of the specified window changes.
This function must only be called from the main thread.
func (*Window) SetCursor ¶
SetCursor sets the cursor image to be used when the cursor is over the client area of the specified window. The set cursor will only be visible when the cursor mode of the window is CursorNormal.
On some platforms, the set cursor may not be visible unless the window also has input focus.
func (*Window) SetCursorEnterCallback ¶
func (w *Window) SetCursorEnterCallback(cbfun CursorEnterCallback) (previous CursorEnterCallback)
SetCursorEnterCallback the cursor boundary crossing callback which is called when the cursor enters or leaves the client area of the window.
func (*Window) SetCursorPos ¶
SetCursorPos sets the position of the cursor. The specified window must be focused. If the window does not have focus when this function is called, it fails silently.
If the cursor is disabled (with CursorDisabled) then the cursor position is unbounded and limited only by the minimum and maximum values of a double.
func (*Window) SetCursorPosCallback ¶
func (w *Window) SetCursorPosCallback(cbfun CursorPosCallback) (previous CursorPosCallback)
SetCursorPosCallback sets the cursor position callback which is called when the cursor is moved. The callback is provided with the position relative to the upper-left corner of the client area of the window.
func (*Window) SetDropCallback ¶
func (w *Window) SetDropCallback(cbfun DropCallback) (previous DropCallback)
SetDropCallback sets the drop callback which is called when an object is dropped over the window.
func (*Window) SetFocusCallback ¶
func (w *Window) SetFocusCallback(cbfun FocusCallback) (previous FocusCallback)
SetFocusCallback sets the focus callback of the window, which is called when the window gains or loses focus.
After the focus callback is called for a window that lost focus, synthetic key and mouse button release events will be generated for all such that had been pressed. For more information, see SetKeyCallback and SetMouseButtonCallback.
func (*Window) SetFramebufferSizeCallback ¶
func (w *Window) SetFramebufferSizeCallback(cbfun FramebufferSizeCallback) (previous FramebufferSizeCallback)
SetFramebufferSizeCallback sets the framebuffer resize callback of the specified window, which is called when the framebuffer of the specified window is resized.
func (*Window) SetIcon ¶
SetIcon sets the icon of the specified window. If passed an array of candidate images, those of or closest to the sizes desired by the system are selected. If no images are specified, the window reverts to its default icon.
The image is ideally provided in the form of *image.NRGBA. The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. They are arranged canonically as packed sequential rows, starting from the top-left corner. If the image type is not *image.NRGBA, it will be converted to it.
The desired image sizes varies depending on platform and system settings. The selected images will be rescaled as needed. Good sizes include 16x16, 32x32 and 48x48.
func (*Window) SetIconifyCallback ¶
func (w *Window) SetIconifyCallback(cbfun IconifyCallback) (previous IconifyCallback)
SetIconifyCallback sets the iconification callback of the window, which is called when the window is iconified or restored.
func (*Window) SetImeStatusCallback ¶
func (w *Window) SetImeStatusCallback(cbfun ImeStatusCallback) (previous ImeStatusCallback)
SetImeStatusCallback sets the callback of change signal of the Ime status to the window.
Users of languages that require text input using an IME should turn on the IME before entering text. This callback receives IME ON/OFF events.
func (*Window) SetInputMode ¶
SetInputMode sets an input option for the window.
func (*Window) SetKeyCallback ¶
func (w *Window) SetKeyCallback(cbfun KeyCallback) (previous KeyCallback)
SetKeyCallback sets the key callback which is called when a key is pressed, repeated or released.
The key functions deal with physical keys, with layout independent key tokens named after their values in the standard US keyboard layout. If you want to input text, use the SetCharCallback instead.
When a window loses focus, it will generate synthetic key release events for all pressed keys. You can tell these events from user-generated events by the fact that the synthetic ones are generated after the window has lost focus, i.e. Focused will be false and the focus callback will have already been called.
func (*Window) SetMaximizeCallback ¶
func (w *Window) SetMaximizeCallback(cbfun MaximizeCallback) MaximizeCallback
SetMaximizeCallback sets the maximization callback of the specified window, which is called when the window is maximized or restored.
This function must only be called from the main thread.
func (*Window) SetMonitor ¶
SetMonitor sets the monitor that the window uses for full screen mode or, if the monitor is NULL, makes it windowed mode.
When setting a monitor, this function updates the width, height and refresh rate of the desired video mode and switches to the video mode closest to it. The window position is ignored when setting a monitor.
When the monitor is NULL, the position, width and height are used to place the window client area. The refresh rate is ignored when no monitor is specified. If you only wish to update the resolution of a full screen window or the size of a windowed mode window, see window.SetSize.
When a window transitions from full screen to windowed mode, this function restores any previous window settings such as whether it is decorated, floating, resizable, has size or aspect ratio limits, etc..
func (*Window) SetMouseButtonCallback ¶
func (w *Window) SetMouseButtonCallback(cbfun MouseButtonCallback) (previous MouseButtonCallback)
SetMouseButtonCallback sets the mouse button callback which is called when a mouse button is pressed or released.
When a window loses focus, it will generate synthetic mouse button release events for all pressed mouse buttons. You can tell these events from user-generated events by the fact that the synthetic ones are generated after the window has lost focus, i.e. Focused will be false and the focus callback will have already been called.
func (*Window) SetOpacity ¶
SetOpacity function sets the opacity of the window, including any decorations. The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque.
The initial opacity value for newly created windows is one.
A window created with framebuffer transparency may not use whole window transparency. The results of doing this are undefined.
This function may only be called from the main thread.
func (*Window) SetPos ¶
SetPos sets the position, in screen coordinates, of the upper-left corner of the client area of the window.
If it is a full screen window, this function does nothing.
If you wish to set an initial window position you should create a hidden window (using Hint and Visible), set its position and then show it.
It is very rarely a good idea to move an already visible window, as it will confuse and annoy the user.
The window manager may put limits on what positions are allowed.
This function may only be called from the main thread.
func (*Window) SetPosCallback ¶
func (w *Window) SetPosCallback(cbfun PosCallback) (previous PosCallback)
SetPosCallback sets the position callback of the window, which is called when the window is moved. The callback is provided with the screen position of the upper-left corner of the client area of the window.
func (*Window) SetPreeditCallback ¶
func (w *Window) SetPreeditCallback(cbfun PreeditCallback) (previous PreeditCallback)
SetPreeditCallback sets the preedit text input callback to the window.
IME Users enter text with the IME turned on. At this time, no char input event occurs in the Window, and the window is notified of the character string of the undefined input token(called preedit). The window must display this token appropriately.
func (*Window) SetPreeditCandidateCallback ¶
func (w *Window) SetPreeditCandidateCallback(cbfun PreeditCandidateCallback) (previous PreeditCandidateCallback)
SetPreeditCandidateCallback sets a callback that receives the information necessary to display a window of the list of conversion candidate strings for preedit.
When an IME user enters preedit, they typically select from a list of conversion candidate tokens. Many OS have a dedicated pull-down display, and you can switch between conversion candidates by using the space, tab, up, down cursor keys. There may be too many selection candidates to display in the pull-down list.
func (*Window) SetRefreshCallback ¶
func (w *Window) SetRefreshCallback(cbfun RefreshCallback) (previous RefreshCallback)
SetRefreshCallback sets the refresh callback of the window, which is called when the client area of the window needs to be redrawn, for example if the window has been exposed after having been covered by another window.
On compositing window systems such as Aero, Compiz or Aqua, where the window contents are saved off-screen, this callback may be called only very infrequently or never at all.
func (*Window) SetScrollCallback ¶
func (w *Window) SetScrollCallback(cbfun ScrollCallback) (previous ScrollCallback)
SetScrollCallback sets the scroll callback which is called when a scrolling device is used, such as a mouse wheel or scrolling area of a touchpad.
func (*Window) SetShouldClose ¶
SetShouldClose sets the value of the close flag of the window. This can be used to override the user's attempt to close the window, or to signal that it should be closed.
func (*Window) SetSize ¶
SetSize sets the size, in screen coordinates, of the client area of the window.
For full screen windows, this function selects and switches to the resolution closest to the specified size, without affecting the window's context. As the context is unaffected, the bit depths of the framebuffer remain unchanged.
The window manager may put limits on what window sizes are allowed.
This function may only be called from the main thread.
func (*Window) SetSizeCallback ¶
func (w *Window) SetSizeCallback(cbfun SizeCallback) (previous SizeCallback)
SetSizeCallback sets the size callback of the window, which is called when the window is resized. The callback is provided with the size, in screen coordinates, of the client area of the window.
func (*Window) SetSizeLimits ¶
SetSizeLimits sets the size limits of the client area of the specified window. If the window is full screen or not resizable, this function does nothing.
The size limits are applied immediately and may cause the window to be resized.
func (*Window) SetTitle ¶
SetTitle sets the window title, encoded as UTF-8, of the window.
This function may only be called from the main thread.
func (*Window) SetUserPointer ¶
SetUserPointer sets the user-defined pointer of the window. The current value is retained until the window is destroyed. The initial value is nil.
func (*Window) ShouldClose ¶
ShouldClose reports the value of the close flag of the specified window.
func (*Window) Show ¶
func (w *Window) Show()
Show makes the window visible, if it was previously hidden. If the window is already visible or is in full screen mode, this function does nothing.
This function may only be called from the main thread.
func (*Window) SwapBuffers ¶
func (w *Window) SwapBuffers()
SwapBuffers swaps the front and back buffers of the window. If the swap interval is greater than zero, the GPU driver waits the specified number of screen updates before swapping the buffers.