allegro

func (*Bitmap) AsTarget ¶

func (bmp *Bitmap) AsTarget(f func()) *Bitmap

AsTarget() is a utility method for temporarily setting a bitmap as the target bitmap, running the provided function, and then undoing the change after the function exits. This is very useful for calling functions that operate on the target bitmap, e.g. the drawing methods provided by the primitives addon.

func (*Bitmap) At ¶

func (bmp *Bitmap) At(x, y int) color.Color

func (*Bitmap) BitmapFlags ¶

func (bmp *Bitmap) BitmapFlags() BitmapFlags

func (*Bitmap) BitmapFormat ¶

func (bmp *Bitmap) BitmapFormat() PixelFormat

func (*Bitmap) Bounds ¶

func (bmp *Bitmap) Bounds() image.Rectangle

func (*Bitmap) Clone ¶

func (bmp *Bitmap) Clone() (*Bitmap, error)

Create a new bitmap with al_create_bitmap, and copy the pixel data from the old bitmap across. The newly created bitmap will be created with the current new bitmap flags, and not the ones that were used to create the original bitmap. If the new bitmap is a memory bitmap, its projection bitmap is reset to be orthographic.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_clone_bitmap

func (*Bitmap) ColorModel ¶

func (bmp *Bitmap) ColorModel() color.Model

image.Image conformity {{{

func (*Bitmap) Convert ¶

func (bmp *Bitmap) Convert()

Converts the bitmap to the current bitmap flags and format. The bitmap will be as if it was created anew with al_create_bitmap but retain its contents. All of this bitmap's sub-bitmaps are also converted. If the new bitmap type is memory, then the bitmap's projection bitmap is reset to be orthographic.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_convert_bitmap

func (*Bitmap) ConvertMaskToAlpha ¶

func (bmp *Bitmap) ConvertMaskToAlpha(mask_color Color)

Convert the given mask color to an alpha channel in the bitmap. Can be used to convert older 4.2-style bitmaps with magic pink to alpha-ready bitmaps.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_convert_mask_to_alpha

func (*Bitmap) CreateSubBitmap ¶

func (bmp *Bitmap) CreateSubBitmap(x, y, w, h int) (*Bitmap, error)

Creates a sub-bitmap of the parent, at the specified coordinates and of the specified size. A sub-bitmap is a bitmap that shares drawing memory with a pre-existing (parent) bitmap, but possibly with a different size and clipping settings.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_create_sub_bitmap

func (*Bitmap) Destroy ¶

func (bmp *Bitmap) Destroy()

Destroys the given bitmap, freeing all resources used by it. This function does nothing if the bitmap argument is NULL.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_destroy_bitmap

func (*Bitmap) Draw ¶

func (bmp *Bitmap) Draw(dx, dy float32, flags DrawFlags)

Draws an unscaled, unrotated bitmap at the given position to the current target bitmap (see al_set_target_bitmap).

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_bitmap

func (*Bitmap) DrawRegion ¶

func (bmp *Bitmap) DrawRegion(sx, sy, sw, sh, dx, dy float32, flags DrawFlags)

Draws a region of the given bitmap to the target bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_bitmap_region

func (*Bitmap) DrawRotated ¶

func (bmp *Bitmap) DrawRotated(cx, cy, dx, dy, angle float32, flags DrawFlags)

Draws a rotated version of the given bitmap to the target bitmap. The bitmap is rotated by 'angle' radians clockwise.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_rotated_bitmap

func (*Bitmap) DrawScaled ¶

func (bmp *Bitmap) DrawScaled(sx, sy, sw, sh, dx, dy, dw, dh float32, flags DrawFlags)

Draws a scaled version of the given bitmap to the target bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_scaled_bitmap

func (*Bitmap) DrawScaledRotated ¶

func (bmp *Bitmap) DrawScaledRotated(cx, cy, dx, dy, xscale, yscale, angle float32, flags DrawFlags)

Like al_draw_rotated_bitmap, but can also scale the bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_scaled_rotated_bitmap

func (*Bitmap) DrawTinted ¶

func (bmp *Bitmap) DrawTinted(tint Color, dx, dy float32, flags DrawFlags)

Like al_draw_bitmap but multiplies all colors in the bitmap with the given color. For example:

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_bitmap

func (*Bitmap) DrawTintedRegion ¶

func (bmp *Bitmap) DrawTintedRegion(tint Color, sx, sy, sw, sh, dx, dy float32, flags DrawFlags)

Like al_draw_bitmap_region but multiplies all colors in the bitmap with the given color.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_bitmap_region

func (*Bitmap) DrawTintedRotated ¶

func (bmp *Bitmap) DrawTintedRotated(tint Color, cx, cy, dx, dy, angle float32, flags DrawFlags)

Like al_draw_rotated_bitmap but multiplies all colors in the bitmap with the given color.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_rotated_bitmap

func (*Bitmap) DrawTintedScaled ¶

func (bmp *Bitmap) DrawTintedScaled(tint Color, sx, sy, sw, sh, dx, dy, dw, dh float32, flags DrawFlags)

Like al_draw_scaled_bitmap but multiplies all colors in the bitmap with the given color.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_scaled_bitmap

func (*Bitmap) DrawTintedScaledRotated ¶

func (bmp *Bitmap) DrawTintedScaledRotated(tint Color, cx, cy, dx, dy, xscale, yscale, angle float32, flags DrawFlags)

Like al_draw_scaled_rotated_bitmap but multiplies all colors in the bitmap with the given color.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_scaled_rotated_bitmap

func (*Bitmap) DrawTintedScaledRotatedRegion ¶

func (bmp *Bitmap) DrawTintedScaledRotatedRegion(sx, sy, sw, sh float32, tint Color, cx, cy, dx, dy, xscale, yscale, angle float32, flags DrawFlags)

Like al_draw_tinted_scaled_rotated_bitmap but you specify an area within the bitmap to be drawn.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_draw_tinted_scaled_rotated_bitmap_region

func (*Bitmap) Flags ¶

func (bmp *Bitmap) Flags() BitmapFlags

Return the flags used to create the bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_flags

func (*Bitmap) Format ¶

func (bmp *Bitmap) Format() PixelFormat

Returns the pixel format of a bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_format

func (*Bitmap) Height ¶

func (bmp *Bitmap) Height() int

Returns the height of a bitmap in pixels.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_height

func (*Bitmap) IsCompatible ¶

func (bmp *Bitmap) IsCompatible() bool

D3D and OpenGL allow sharing a texture in a way so it can be used for multiple windows. Each ALLEGRO_BITMAP created with al_create_bitmap however is usually tied to a single ALLEGRO_DISPLAY. This function can be used to know if the bitmap is compatible with the given display, even if it is a different display to the one it was created with. It returns true if the bitmap is compatible (things like a cached texture version can be used) and false otherwise (blitting in the current display will be slow).

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_is_compatible_bitmap

func (*Bitmap) IsLocked ¶

func (bmp *Bitmap) IsLocked() bool

Returns whether or not a bitmap is already locked.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_is_bitmap_locked

func (*Bitmap) IsSubBitmap ¶

func (bmp *Bitmap) IsSubBitmap() bool

Returns true if the specified bitmap is a sub-bitmap, false otherwise.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_is_sub_bitmap

func (*Bitmap) Lock ¶

func (bmp *Bitmap) Lock(format PixelFormat, flags LockFlags) (*LockedRegion, error)

Lock an entire bitmap for reading or writing. If the bitmap is a display bitmap it will be updated from system memory after the bitmap is unlocked (unless locked read only). Returns NULL if the bitmap cannot be locked, e.g. the bitmap was locked previously and not unlocked. This function also returns NULL if the format is a compressed format.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_lock_bitmap

func (*Bitmap) LockBlocked ¶

func (bmp *Bitmap) LockBlocked(flags LockFlags) (*LockedRegion, error)

Like al_lock_bitmap, but allows locking bitmaps with a blocked pixel format (i.e. a format for which al_get_pixel_block_width or al_get_pixel_block_height do not return 1) in that format. To that end, this function also does not allow format conversion. For bitmap formats with a block size of 1, this function is identical to calling al_lock_bitmap(bmp, al_get_bitmap_format(bmp), flags).

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_lock_bitmap_blocked

func (*Bitmap) LockRegion ¶

func (bmp *Bitmap) LockRegion(x, y, width, height int, format PixelFormat, flags LockFlags) (*LockedRegion, error)

Like al_lock_bitmap, but only locks a specific area of the bitmap. If the bitmap is a video bitmap, only that area of the texture will be updated when it is unlocked. Locking only the region you indend to modify will be faster than locking the whole bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_lock_bitmap_region

func (*Bitmap) LockRegionBlocked ¶

func (bmp *Bitmap) LockRegionBlocked(x, y, width, height int, flags LockFlags) (*LockedRegion, error)

Like al_lock_bitmap_blocked, but allows locking a sub-region, for performance. Unlike al_lock_bitmap_region the region specified in terms of blocks and not pixels.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_lock_bitmap_region_blocked

func (*Bitmap) Parent ¶

func (bmp *Bitmap) Parent() (*Bitmap, error)

Returns the bitmap this bitmap is a sub-bitmap of. Returns NULL if this bitmap is not a sub-bitmap. This function always returns the real bitmap, and never a sub-bitmap. This might NOT match what was passed to al_create_sub_bitmap. Consider this code, for instance:

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_parent_bitmap

func (*Bitmap) ParentBitmap ¶

func (bmp *Bitmap) ParentBitmap() (*Bitmap, error)

func (*Bitmap) Pixel ¶

func (bmp *Bitmap) Pixel(x, y int) Color

Get a pixel's color value from the specified bitmap. This operation is slow on non-memory bitmaps. Consider locking the bitmap if you are going to use this function multiple times on the same bitmap.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_pixel

func (*Bitmap) Reparent ¶

func (bmp *Bitmap) Reparent(parent *Bitmap, x, y, w, h int)

For a sub-bitmap, changes the parent, position and size. This is the same as destroying the bitmap and re-creating it with al_create_sub_bitmap - except the bitmap pointer stays the same. This has many uses, for example an animation player could return a single bitmap which can just be re-parented to different animation frames without having to re-draw the contents. Or a sprite atlas could re-arrange its sprites without having to invalidate all existing bitmaps.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_reparent_bitmap

func (*Bitmap) Save ¶

func (bmp *Bitmap) Save(filename string) error

Saves an ALLEGRO_BITMAP to an image file. The file type is determined by the extension.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_save_bitmap

func (*Bitmap) Set ¶

func (bmp *Bitmap) Set(x, y int, c color.Color)

func (*Bitmap) Unlock ¶

func (bmp *Bitmap) Unlock()

Unlock a previously locked bitmap or bitmap region. If the bitmap is a video bitmap, the texture will be updated to match the system memory copy (unless it was locked read only).

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_unlock_bitmap

func (*Bitmap) WhileLocked ¶

func (bmp *Bitmap) WhileLocked(format PixelFormat, flags LockFlags, f func()) error

Convenience method for acting on a locked Bitmap, which will automatically be unlocked after the function completes.

func (*Bitmap) Width ¶

func (bmp *Bitmap) Width() int

Returns the width of a bitmap in pixels.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_width

func (*Bitmap) WithLockedTarget ¶

func (bmp *Bitmap) WithLockedTarget(format PixelFormat, flags LockFlags, f func()) error

func (*Bitmap) X ¶

func (bmp *Bitmap) X() int

For a sub-bitmap, return it's x position within the parent.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_x

func (*Bitmap) Y ¶

func (bmp *Bitmap) Y() int

For a sub-bitmap, return it's y position within the parent.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_bitmap_y

func (Color) RGBA ¶

func (c Color) RGBA() (r, g, b, a uint32)

func (Color) UnmapRGB ¶

func (c Color) UnmapRGB() (byte, byte, byte)

Retrieves components of an ALLEGRO_COLOR, ignoring alpha. Components will range from 0-255.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_unmap_rgb

func (Color) UnmapRGBA ¶

func (c Color) UnmapRGBA() (byte, byte, byte, byte)

Retrieves components of an ALLEGRO_COLOR. Components will range from 0-255.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_unmap_rgba

func (Color) UnmapRGBAf ¶

func (c Color) UnmapRGBAf() (float32, float32, float32, float32)

Retrieves components of an ALLEGRO_COLOR. Components will range from 0.0f-1.0f.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_unmap_rgba_f

func (Color) UnmapRGBf ¶

func (c Color) UnmapRGBf() (float32, float32, float32)

Retrieves components of an ALLEGRO_COLOR, ignoring alpha. Components will range from 0.0f-1.0f.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_unmap_rgb_f

func (*Config) AddComment ¶

func (cfg *Config) AddComment(section, comment string)

Add a comment in a section of a configuration. If the section doesn't yet exist, it will be created. The section can be NULL or "" for the global section.

See https://liballeg.org/a5docs/5.2.6/config.html#al_add_config_comment

func (*Config) AddSection ¶

func (cfg *Config) AddSection(name string)

Add a section to a configuration structure with the given name. If the section already exists then nothing happens.

See https://liballeg.org/a5docs/5.2.6/config.html#al_add_config_section

func (*Config) Destroy ¶

func (cfg *Config) Destroy()

Free the resources used by a configuration structure. Does nothing if passed NULL.

See https://liballeg.org/a5docs/5.2.6/config.html#al_destroy_config

func (*Config) Entries ¶

func (cfg *Config) Entries(section string) <-chan string

Entries() returns a read-only channel of entries in the config file. This makes it easy to iterate over them like so:

for entry := range cfg.Entries("Section Title") {
    // do stuff
}

func (*Config) FirstConfigEntry ¶

func (cfg *Config) FirstConfigEntry(section string) (string, *ConfigEntryIterator, error)

Returns the name of the first key in the given section in the given config or NULL if the section is empty. The iterator works like the one for al_get_first_config_section.

See https://liballeg.org/a5docs/5.2.6/config.html#al_get_first_config_entry

func (*Config) FirstConfigSection ¶

func (cfg *Config) FirstConfigSection() (string, *ConfigSectionIterator)

Returns the name of the first section in the given config file. Usually this will return an empty string for the global section, even it contains no values. The iterator parameter will receive an opaque iterator which is used by al_get_next_config_section to iterate over the remaining sections.

See https://liballeg.org/a5docs/5.2.6/config.html#al_get_first_config_section

func (*Config) Float32Value ¶

func (cfg *Config) Float32Value(section, key string) (float32, error)

func (*Config) Float64Value ¶

func (cfg *Config) Float64Value(section, key string) (float64, error)

func (*Config) IntValue ¶

func (cfg *Config) IntValue(section, key string) (int64, error)

func (*Config) Merge ¶

func (cfg *Config) Merge(add *Config)

Merge one configuration structure into another. Values in configuration 'add' override those in 'master'. 'master' is modified. Comments from 'add' are not retained.

See https://liballeg.org/a5docs/5.2.6/config.html#al_merge_config_into

func (*Config) NextConfigEntry ¶

func (cfg *Config) NextConfigEntry(iter *ConfigEntryIterator) (string, error)

Returns the next key for the iterator obtained by al_get_first_config_entry. The iterator works like the one for al_get_next_config_section.

See https://liballeg.org/a5docs/5.2.6/config.html#al_get_next_config_entry

func (*Config) NextConfigSection ¶

func (cfg *Config) NextConfigSection(iter *ConfigSectionIterator) (string, error)

Returns the name of the next section in the given config file or NULL if there are no more sections. The iterator must have been obtained with al_get_first_config_section first.

See https://liballeg.org/a5docs/5.2.6/config.html#al_get_next_config_section

func (*Config) RemoveKey ¶

func (cfg *Config) RemoveKey(section, key string) bool

Remove a key and its associated value in a section of a configuration.

See https://liballeg.org/a5docs/5.2.6/config.html#al_remove_config_key

func (*Config) RemoveSection ¶

func (cfg *Config) RemoveSection(name string)

Remove a section of a configuration.

See https://liballeg.org/a5docs/5.2.6/config.html#al_remove_config_section

func (*Config) Save ¶

func (cfg *Config) Save(filename string) error

Write out a configuration file to disk. Returns true on success, false on error.

See https://liballeg.org/a5docs/5.2.6/config.html#al_save_config_file

func (*Config) Sections ¶

func (cfg *Config) Sections() <-chan string

Sections() returns a read-only channel of sections in the config file. This makes it easy to iterate over them like so:

for section := range cfg.Sections() {
    // do stuff
}

func (*Config) SetValue ¶

func (cfg *Config) SetValue(section, key, value string)

Set a value in a section of a configuration. If the section doesn't yet exist, it will be created. If a value already existed for the given key, it will be overwritten. The section can be NULL or "" for the global section.

See https://liballeg.org/a5docs/5.2.6/config.html#al_set_config_value

func (*Config) UintValue ¶

func (cfg *Config) UintValue(section, key string) (uint64, error)

func (*Config) Value ¶

func (cfg *Config) Value(section, key string) (string, error)

Gets a pointer to an internal character buffer that will only remain valid as long as the ALLEGRO_CONFIG structure is not destroyed. Copy the value if you need a copy. The section can be NULL or "" for the global section. Returns NULL if the section or key do not exist.

See https://liballeg.org/a5docs/5.2.6/config.html#al_get_config_value

func (*Display) AcknowledgeResize ¶

func (d *Display) AcknowledgeResize() bool

When the user receives a resize event from a resizable display, if they wish the display to be resized they must call this function to let the graphics driver know that it can now resize the display. Returns true on success.

See https://liballeg.org/a5docs/5.2.6/display.html#al_acknowledge_resize

func (*Display) Backbuffer ¶

func (d *Display) Backbuffer() *Bitmap

Return a special bitmap representing the back-buffer of the display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_backbuffer

func (*Display) ClipboardHasText ¶

func (d *Display) ClipboardHasText() bool

This function returns true if and only if the clipboard has text available.

See https://liballeg.org/a5docs/5.2.6/display.html#al_clipboard_has_text

func (*Display) ClipboardText ¶

func (d *Display) ClipboardText() string

This function returns a pointer to a string, allocated with al_malloc with the text contents of the clipboard if available. If no text is available on the clipboard then this function returns NULL. You must call al_free on the returned pointer when you don't need it anymore.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_clipboard_text

func (*Display) Destroy ¶

func (d *Display) Destroy()

Destroy a display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_destroy_display

func (*Display) DisplayFormat ¶

func (d *Display) DisplayFormat() PixelFormat

Gets the pixel format of the display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_format

func (*Display) DisplayOption ¶

func (d *Display) DisplayOption(option DisplayOption) int

Return an extra display setting of the display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_option

func (*Display) EventSource ¶

func (d *Display) EventSource() *EventSource

Retrieve the associated event source. See the documentation on events for a list of the events displays will generate.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_event_source

func (*Display) GrabMouse ¶

func (d *Display) GrabMouse() error

Confine the mouse cursor to the given display. The mouse cursor can only be confined to one display at a time.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_grab_mouse

func (*Display) Height ¶

func (d *Display) Height() int

Gets the height of the display. This is like SCREEN_H in Allegro 4.x.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_height

func (*Display) HideMouseCursor ¶

func (d *Display) HideMouseCursor() error

Hide the mouse cursor in the given display. This has no effect on what the current mouse cursor looks like; it just makes it disappear.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_hide_mouse_cursor

func (*Display) RefreshRate ¶

func (d *Display) RefreshRate() int

Gets the refresh rate of the display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_refresh_rate

func (*Display) Resize ¶

func (d *Display) Resize(width, height int) error

Resize the display. Returns true on success, or false on error. This works on both fullscreen and windowed displays, regardless of the ALLEGRO_RESIZABLE flag.

See https://liballeg.org/a5docs/5.2.6/display.html#al_resize_display

func (*Display) SetClipboardText ¶

func (d *Display) SetClipboardText(text string)

This function pastes the text given as an argument to the clipboard.

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_clipboard_text

func (*Display) SetDisplayFlag ¶

func (d *Display) SetDisplayFlag(flags DisplayFlags, onoff bool) error

Enable or disable one of the display flags. The flags are the same as for al_set_new_display_flags. The only flags that can be changed after creation are:

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_display_flag

func (*Display) SetDisplayIcon ¶

func (d *Display) SetDisplayIcon(icon *Bitmap)

Changes the icon associated with the display (window). Same as al_set_display_icons with one icon.

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_display_icon

func (*Display) SetDisplayIcons ¶

func (d *Display) SetDisplayIcons(icons []*Bitmap)

Changes the icons associated with the display (window). Multiple icons can be provided for use in different contexts, e.g. window frame, taskbar, alt-tab popup. The number of icons must be at least one.

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_display_icons

func (*Display) SetMouseCursor ¶

func (d *Display) SetMouseCursor(cursor *MouseCursor) error

Set the given mouse cursor to be the current mouse cursor for the given display.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_set_mouse_cursor

func (*Display) SetMouseXY ¶

func (d *Display) SetMouseXY(x, y int) error

Try to position the mouse at the given coordinates on the given display. The mouse movement resulting from a successful move will generate an ALLEGRO_EVENT_MOUSE_WARPED event.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_set_mouse_xy

func (*Display) SetSystemMouseCursor ¶

func (d *Display) SetSystemMouseCursor(cursor SystemMouseCursor) error

Set the given system mouse cursor to be the current mouse cursor for the given display. If the cursor is currently 'shown' (as opposed to 'hidden') the change is immediately visible.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_set_system_mouse_cursor

func (*Display) SetWindowPosition ¶

func (d *Display) SetWindowPosition(x, y int)

Sets the position on screen of a non-fullscreen display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_window_position

func (*Display) SetWindowTitle ¶

func (d *Display) SetWindowTitle(title string)

Set the title on a display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_set_window_title

func (*Display) ShowMouseCursor ¶

func (d *Display) ShowMouseCursor() error

Make a mouse cursor visible in the given display.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_show_mouse_cursor

func (*Display) Width ¶

func (d *Display) Width() int

Gets the width of the display. This is like SCREEN_W in Allegro 4.x.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_display_width

func (*Display) WindowPosition ¶

func (d *Display) WindowPosition() (int, int)

Gets the position of a non-fullscreen display.

See https://liballeg.org/a5docs/5.2.6/display.html#al_get_window_position

func (*DisplayMode) Format ¶

func (m *DisplayMode) Format() PixelFormat

Pixel format.

func (*DisplayMode) Height ¶

func (m *DisplayMode) Height() int

Screen height.

func (*DisplayMode) RefreshRate ¶

func (m *DisplayMode) RefreshRate() int

Refresh rate. May be 0 if unknown.

func (*DisplayMode) Width ¶

func (m *DisplayMode) Width() int

Screen width.

func (*Error) Error ¶

func (e *Error) Error() string

func (*EventQueue) Destroy ¶

func (queue *EventQueue) Destroy()

Destroy the event queue specified. All event sources currently registered with the queue will be automatically unregistered before the queue is destroyed.

See https://liballeg.org/a5docs/5.2.6/events.html#al_destroy_event_queue

func (*EventQueue) DropNextEvent ¶

func (queue *EventQueue) DropNextEvent() bool

Drop (remove) the next event from the queue. If the queue is empty, nothing happens. Returns true if an event was dropped.

See https://liballeg.org/a5docs/5.2.6/events.html#al_drop_next_event

func (*EventQueue) Flush ¶

func (queue *EventQueue) Flush()

Drops all events, if any, from the queue.

See https://liballeg.org/a5docs/5.2.6/events.html#al_flush_event_queue

func (*EventQueue) GetNextEvent ¶

func (queue *EventQueue) GetNextEvent(event *Event) (interface{}, error)

Take the next event out of the event queue specified, and copy the contents into ret_event, returning true. The original event will be removed from the queue. If the event queue is empty, return false and the contents of ret_event are unspecified.

See https://liballeg.org/a5docs/5.2.6/events.html#al_get_next_event

func (*EventQueue) IsEmpty ¶

func (queue *EventQueue) IsEmpty() bool

Return true if the event queue specified is currently empty.

See https://liballeg.org/a5docs/5.2.6/events.html#al_is_event_queue_empty

func (*EventQueue) PeekNextEvent ¶

func (queue *EventQueue) PeekNextEvent(event *Event) (interface{}, error)

Copy the contents of the next event in the event queue specified into ret_event and return true. The original event packet will remain at the head of the queue. If the event queue is actually empty, this function returns false and the contents of ret_event are unspecified.

See https://liballeg.org/a5docs/5.2.6/events.html#al_peek_next_event

func (*EventQueue) Register ¶

func (queue *EventQueue) Register(obs ...EventGenerator)

Shorthand method for registering anything with an EventSource() method.

func (*EventQueue) RegisterEventSource ¶

func (queue *EventQueue) RegisterEventSource(source *EventSource)

Register the event source with the event queue specified. An event source may be registered with any number of event queues simultaneously, or none. Trying to register an event source with the same event queue more than once does nothing.

See https://liballeg.org/a5docs/5.2.6/events.html#al_register_event_source

func (*EventQueue) Unregister ¶

func (queue *EventQueue) Unregister(ob EventGenerator)

Shorthand method for registering anything with an EventSource() method.

func (*EventQueue) UnregisterEventSource ¶

func (queue *EventQueue) UnregisterEventSource(source *EventSource)

Unregister an event source with an event queue. If the event source is not actually registered with the event queue, nothing happens.

See https://liballeg.org/a5docs/5.2.6/events.html#al_unregister_event_source

func (*EventQueue) WaitForEvent ¶

func (queue *EventQueue) WaitForEvent(event *Event) interface{}

Wait until the event queue specified is non-empty. If ret_event is not NULL, the first event in the queue will be copied into ret_event and removed from the queue. If ret_event is NULL the first event is left at the head of the queue.

See https://liballeg.org/a5docs/5.2.6/events.html#al_wait_for_event

func (*EventQueue) WaitForEventTimed ¶

func (queue *EventQueue) WaitForEventTimed(event *Event, secs float32) (interface{}, bool)

Wait until the event queue specified is non-empty. If ret_event is not NULL, the first event in the queue will be copied into ret_event and removed from the queue. If ret_event is NULL the first event is left at the head of the queue.

See https://liballeg.org/a5docs/5.2.6/events.html#al_wait_for_event_timed

func (*EventQueue) WaitForEventUntil ¶

func (queue *EventQueue) WaitForEventUntil(timeout *Timeout, event *Event) (interface{}, bool)

Wait until the event queue specified is non-empty. If ret_event is not NULL, the first event in the queue will be copied into ret_event and removed from the queue. If ret_event is NULL the first event is left at the head of the queue.

See https://liballeg.org/a5docs/5.2.6/events.html#al_wait_for_event_until

func (*EventSource) Data ¶

func (source *EventSource) Data() uintptr

Returns the abstract user data associated with the event source. If no data was previously set, returns NULL.

See https://liballeg.org/a5docs/5.2.6/events.html#al_get_event_source_data

func (*EventSource) DestroyUserEventSource ¶

func (source *EventSource) DestroyUserEventSource()

Destroy an event source initialised with al_init_user_event_source.

See https://liballeg.org/a5docs/5.2.6/events.html#al_destroy_user_event_source

func (*EventSource) EmitUserEvent ¶

func (source *EventSource) EmitUserEvent(data ...uintptr) error

Emit an event from a user event source. The event source must have been initialised with al_init_user_event_source. Returns false if the event source isn't registered with any queues, hence the event wouldn't have been delivered into any queues.

See https://liballeg.org/a5docs/5.2.6/events.html#al_emit_user_event

func (EventSource) InitUserEventSource ¶

func (source EventSource) InitUserEventSource()

Initialise an event source for emitting user events. The space for the event source must already have been allocated.

See https://liballeg.org/a5docs/5.2.6/events.html#al_init_user_event_source

func (*EventSource) SetData ¶

func (source *EventSource) SetData(data uintptr)

Assign the abstract user data to the event source. Allegro does not use the data internally for anything; it is simply meant as a convenient way to associate your own data or objects with events.

See https://liballeg.org/a5docs/5.2.6/events.html#al_set_event_source_data

func (*File) ClearError ¶

func (f *File) ClearError()

Clear the error indicator for the given file.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fclearerr

func (*File) Close ¶

func (f *File) Close() error

Close the given file, writing any buffered output data (if any).

See https://liballeg.org/a5docs/5.2.6/file.html#al_fclose

func (*File) Eof ¶

func (f *File) Eof() bool

Returns true if the end-of-file indicator has been set on the file, i.e. we have attempted to read past the end of the file.

See https://liballeg.org/a5docs/5.2.6/file.html#al_feof

func (*File) Flush ¶

func (f *File) Flush() error

Flush any pending writes to the given file.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fflush

func (*File) Getc ¶

func (f *File) Getc() (byte, error)

Read and return next byte in the given file. Returns EOF on end of file or if an error occurred.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fgetc

func (*File) HasError ¶

func (f *File) HasError() bool

Returns non-zero if the error indicator is set on the given file, i.e. there was some sort of previous error. The error code may be system or file interface specific.

See https://liballeg.org/a5docs/5.2.6/file.html#al_ferror

func (*File) LoadBitmap ¶

func (f *File) LoadBitmap(ident string) (*Bitmap, error)

Loads an image from an ALLEGRO_FILE stream into a new ALLEGRO_BITMAP. The file type is determined by the passed 'ident' parameter, which is a file name extension including the leading dot. If (and only if) 'ident' is NULL, the file type is determined with al_identify_bitmap_f instead.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_load_bitmap_f

func (*File) LoadBitmapFlags ¶

func (f *File) LoadBitmapFlags(ident string, flags BitmapFlags) (*Bitmap, error)

Loads an image from an ALLEGRO_FILE stream into a new ALLEGRO_BITMAP. The file type is determined by the passed 'ident' parameter, which is a file name extension including the leading dot. If (and only if) 'ident' is NULL, the file type is determined with al_identify_bitmap_f instead.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_load_bitmap_flags_f

func (*File) LoadConfig ¶

func (f *File) LoadConfig() (*Config, error)

Read a configuration file from an already open file.

See https://liballeg.org/a5docs/5.2.6/config.html#al_load_config_file_f

func (*File) Putc ¶

func (f *File) Putc(b byte) byte

Write a single byte to the given file. The byte written is the value of c cast to an unsigned char.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fputc

func (*File) Read ¶

func (f *File) Read(b []byte) (n int, err error)

Read 'size' bytes into the buffer pointed to by 'ptr', from the given file.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fread

func (*File) SaveBitmap ¶

func (f *File) SaveBitmap(ident string, bmp *Bitmap) error

Saves an ALLEGRO_BITMAP to an ALLEGRO_FILE stream. The file type is determined by the passed 'ident' parameter, which is a file name extension including the leading dot.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_save_bitmap_f

func (*File) SaveConfig ¶

func (f *File) SaveConfig(cfg *Config) error

Write out a configuration file to an already open file.

See https://liballeg.org/a5docs/5.2.6/config.html#al_save_config_file_f

func (*File) Seek ¶

func (f *File) Seek(offset int64, whence int) (ret int64, err error)

Set the current position of the given file to a position relative to that specified by 'whence', plus 'offset' number of bytes.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fseek

func (*File) Size ¶

func (f *File) Size() (int64, error)

Return the size of the file, if it can be determined, or -1 otherwise.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fsize

func (*File) Slice ¶

func (f *File) Slice(initial_size int, mode FileMode) (*File, error)

Opens a slice (subset) of an already open random access file as if it were a stand alone file. While the slice is open, the parent file handle must not be used in any way.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fopen_slice

func (*File) Tell ¶

func (f *File) Tell() (int64, error)

Returns the current position in the given file, or -1 on error. errno is set to indicate the error.

See https://liballeg.org/a5docs/5.2.6/file.html#al_ftell

func (*File) Ungetc ¶

func (f *File) Ungetc(b byte) byte

Ungets a single byte from a file. Pushed-back bytes are not written to the file, only made available for subsequent reads, in reverse order.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fungetc

func (*File) Write ¶

func (f *File) Write(b []byte) (n int, err error)

Write 'size' bytes from the buffer pointed to by 'ptr' into the given file.

See https://liballeg.org/a5docs/5.2.6/file.html#al_fwrite

func (FileMode) String ¶

func (m FileMode) String() string

func (*Joystick) Active ¶

func (j *Joystick) Active() bool

Return if the joystick handle is "active", i.e. in the current configuration, the handle represents some physical device plugged into the system. al_get_joystick returns active handles. After reconfiguration, active handles may become inactive, and vice versa.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_active

func (*Joystick) AxisName ¶

func (j *Joystick) AxisName(stick, axis int) (string, error)

Return the name of the given axis. If the axis doesn't exist, NULL is returned. Indices begin from 0.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_axis_name

func (*Joystick) ButtonName ¶

func (j *Joystick) ButtonName(stick int) (string, error)

Return the name of the given button. If the button doesn't exist, NULL is returned. Indices begin from 0.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_button_name

func (*Joystick) Name ¶

func (j *Joystick) Name() string

Return the name of the given joystick.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_name

func (*Joystick) NumAxes ¶

func (j *Joystick) NumAxes(stick int) int

Return the number of axes on the given "stick". If the stick doesn't exist, 0 is returned.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_num_axes

func (*Joystick) NumButtons ¶

func (j *Joystick) NumButtons() int

Return the number of buttons on the joystick.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_num_buttons

func (*Joystick) NumSticks ¶

func (j *Joystick) NumSticks() int

Return the number of "sticks" on the given joystick. A stick has one or more axes.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_num_sticks

func (*Joystick) Release ¶

func (j *Joystick) Release()

This function currently does nothing.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_release_joystick

func (*Joystick) State ¶

func (j *Joystick) State() *JoystickState

func (*Joystick) StickFlags ¶

func (j *Joystick) StickFlags(stick int) JoyFlags

Return the flags of the given "stick". If the stick doesn't exist, NULL is returned. Indices begin from 0.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_stick_flags

func (*Joystick) StickName ¶

func (j *Joystick) StickName(stick int) (string, error)

Return the name of the given "stick". If the stick doesn't exist, NULL is returned.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_stick_name

func (*JoystickState) Get ¶

func (state *JoystickState) Get()

Get the current joystick state.

See https://liballeg.org/a5docs/5.2.6/joystick.html#al_get_joystick_state

func (KeyCode) Name ¶

func (key KeyCode) Name() string

Converts the given keycode to a description of the key.

See https://liballeg.org/a5docs/5.2.6/keyboard.html#al_keycode_to_name

func (KeyCode) String ¶

func (key KeyCode) String() string

Implement the Stringer interface.

func (*KeyboardState) Get ¶

func (state *KeyboardState) Get()

Save the state of the keyboard specified at the time the function is called into the structure pointed to by ret_state.

See https://liballeg.org/a5docs/5.2.6/keyboard.html#al_get_keyboard_state

func (*KeyboardState) IsDown ¶

func (state *KeyboardState) IsDown(key KeyCode) bool

Return true if the key specified was held down in the state specified.

See https://liballeg.org/a5docs/5.2.6/keyboard.html#al_key_down

func (*LockedRegion) Data ¶

func (reg *LockedRegion) Data() uintptr

func (*LockedRegion) Format ¶

func (reg *LockedRegion) Format() PixelFormat

func (*LockedRegion) Pitch ¶

func (reg *LockedRegion) Pitch() int

func (*LockedRegion) PixelSize ¶

func (reg *LockedRegion) PixelSize() int

func (*MonitorInfo) Height ¶

func (m *MonitorInfo) Height() int

func (*MonitorInfo) IsPrimary ¶

func (m *MonitorInfo) IsPrimary() bool

Convenience method for testing whether or not this is the primary monitor. Returns true iff x1 and y1 are both 0.

func (*MonitorInfo) Width ¶

func (m *MonitorInfo) Width() int

func (*MonitorInfo) X1 ¶

func (m *MonitorInfo) X1() int

func (*MonitorInfo) X2 ¶

func (m *MonitorInfo) X2() int

func (*MonitorInfo) Y1 ¶

func (m *MonitorInfo) Y1() int

func (*MonitorInfo) Y2 ¶

func (m *MonitorInfo) Y2() int

func (*MouseCursor) Destroy ¶

func (cursor *MouseCursor) Destroy()

Free the memory used by the given cursor.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_destroy_mouse_cursor

func (*MouseState) Axis ¶

func (state *MouseState) Axis(axis int) int

Extract the mouse axis value from the saved state. The axes are numbered from 0, in this order: x-axis, y-axis, z-axis, w-axis.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_get_mouse_state_axis

func (*MouseState) ButtonDown ¶

func (state *MouseState) ButtonDown(button int) bool

Return true if the mouse button specified was held down in the state specified. Unlike most things, the first mouse button is numbered 1.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_mouse_button_down

func (*MouseState) Buttons ¶

func (state *MouseState) Buttons() int

func (*MouseState) Get ¶

func (state *MouseState) Get()

Save the state of the mouse specified at the time the function is called into the given structure.

See https://liballeg.org/a5docs/5.2.6/mouse.html#al_get_mouse_state

func (*MouseState) Pressure ¶

func (state *MouseState) Pressure() float32

func (*MouseState) W ¶

func (state *MouseState) W() int

func (*MouseState) X ¶

func (state *MouseState) X() int

func (*MouseState) Y ¶

func (state *MouseState) Y() int

func (*MouseState) Z ¶

func (state *MouseState) Z() int

func (PixelFormat) PixelFormatBits ¶

func (format PixelFormat) PixelFormatBits() int

Return the number of bits that a pixel of the given format occupies. For blocked pixel formats (e.g. compressed formats), this returns 0.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_pixel_format_bits

func (PixelFormat) PixelSize ¶

func (format PixelFormat) PixelSize() int

Return the number of bytes that a pixel of the given format occupies. For blocked pixel formats (e.g. compressed formats), this returns 0.

See https://liballeg.org/a5docs/5.2.6/graphics.html#al_get_pixel_size

func (*Timer) AddCount ¶

func (t *Timer) AddCount(diff int64)

Add diff to the timer's counter value. This is similar to writing:

See https://liballeg.org/a5docs/5.2.6/timer.html#al_add_timer_count

func (*Timer) Count ¶

func (t *Timer) Count() int64

Return the timer's counter value. The timer can be started or stopped.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_get_timer_count

func (*Timer) Destroy ¶

func (t *Timer) Destroy()

Uninstall the timer specified. If the timer is started, it will automatically be stopped before uninstallation. It will also automatically unregister the timer with any event queues.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_destroy_timer

func (*Timer) EventSource ¶

func (t *Timer) EventSource() *EventSource

Retrieve the associated event source. Timers will generate events of type ALLEGRO_EVENT_TIMER.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_get_timer_event_source

func (*Timer) IsStarted ¶

func (t *Timer) IsStarted() bool

Return true if the timer specified is currently started.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_get_timer_started

func (*Timer) SetCount ¶

func (t *Timer) SetCount(count int64)

Set the timer's counter value. The timer can be started or stopped. The count value may be positive or negative, but will always be incremented by +1 at each tick.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_set_timer_count

func (*Timer) SetSpeed ¶

func (t *Timer) SetSpeed(speed float64)

Set the timer's speed, i.e. the rate at which its counter will be incremented when it is started. This can be done when the timer is started or stopped. If the timer is currently running, it is made to look as though the speed change occurred precisely at the last tick.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_set_timer_speed

func (*Timer) Speed ¶

func (t *Timer) Speed() float64

Return the timer's speed, in seconds. (The same value passed to al_create_timer or al_set_timer_speed.)

See https://liballeg.org/a5docs/5.2.6/timer.html#al_get_timer_speed

func (*Timer) Start ¶

func (t *Timer) Start()

Start the timer specified. From then, the timer's counter will increment at a constant rate, and it will begin generating events. Starting a timer that is already started does nothing. Starting a timer that was stopped will reset the timer's counter, effectively restarting the timer from the beginning.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_start_timer

func (*Timer) Stop ¶

func (t *Timer) Stop()

Stop the timer specified. The timer's counter will stop incrementing and it will stop generating events. Stopping a timer that is already stopped does nothing.

See https://liballeg.org/a5docs/5.2.6/timer.html#al_stop_timer

func (*Transform) CheckInverse ¶

func (t *Transform) CheckInverse(tol float32) bool

Checks if the transformation has an inverse using the supplied tolerance. Tolerance should be a small value between 0 and 1, with 1e-7 being sufficient for most applications.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_check_inverse

func (*Transform) Compose ¶

func (t *Transform) Compose(other *Transform)

Compose (combine) two transformations by a matrix multiplication.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_compose_transform

func (*Transform) Coordinates ¶

func (t *Transform) Coordinates(x, y float32) (float32, float32)

Transform a pair of coordinates.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_transform_coordinates

func (*Transform) Copy ¶

func (t *Transform) Copy() *Transform

Makes a copy of a transformation.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_copy_transform

func (*Transform) Identity ¶

func (t *Transform) Identity()

Sets the transformation to be the identity transformation. This is the default transformation. Use al_use_transform on an identity transformation to return to the default.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_identity_transform

func (*Transform) Invert ¶

func (t *Transform) Invert()

Inverts the passed transformation. If the transformation is nearly singular (close to not having an inverse) then the returned transformation may be invalid. Use al_check_inverse to ascertain if the transformation has an inverse before inverting it if you are in doubt.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_invert_transform

func (*Transform) Rotate ¶

func (t *Transform) Rotate(theta float32)

Apply a rotation to a transformation.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_rotate_transform

func (*Transform) Scale ¶

func (t *Transform) Scale(sx, sy float32)

Apply a scale to a transformation.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_scale_transform

func (*Transform) Translate ¶

func (t *Transform) Translate(x, y float32)

Apply a translation to a transformation.

See https://liballeg.org/a5docs/5.2.6/transformations.html#al_translate_transform