gosfml2

func (*CircleShape) Copy ¶

func (this *CircleShape) Copy() *CircleShape

Copy an existing circle shape

func (*CircleShape) Draw ¶

func (this *CircleShape) Draw(target RenderTarget, renderStates RenderStates)

Draws a CircleShape on a render target

func (*CircleShape) GetFillColor ¶

func (this *CircleShape) GetFillColor() (color Color)

Get the fill color of a circle shape

func (*CircleShape) GetGlobalBounds ¶

func (this *CircleShape) GetGlobalBounds() (rect FloatRect)

Get the global bounding rectangle of a circle shape

The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.

func (*CircleShape) GetInverseTransform ¶

func (this *CircleShape) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a circle shape

func (*CircleShape) GetLocalBounds ¶

func (this *CircleShape) GetLocalBounds() (rect FloatRect)

Get the local bounding rectangle of a circle shape

The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.

func (*CircleShape) GetOrigin ¶

func (this *CircleShape) GetOrigin() (origin Vector2f)

Get the local origin of a circle shape

func (*CircleShape) GetOutlineColor ¶

func (this *CircleShape) GetOutlineColor() (color Color)

Get the outline color of a circle shape

func (*CircleShape) GetOutlineThickness ¶

func (this *CircleShape) GetOutlineThickness() float32

Get the outline thickness of a circle shape

func (*CircleShape) GetPoint ¶

func (this *CircleShape) GetPoint(index uint) (point Vector2f)

Get the total number of points of a circle shape

func (*CircleShape) GetPointCount ¶

func (this *CircleShape) GetPointCount() uint

func (*CircleShape) GetPosition ¶

func (this *CircleShape) GetPosition() (position Vector2f)

Get the position of a circle shape

func (*CircleShape) GetRadius ¶

func (this *CircleShape) GetRadius() float32

Get the radius of a circle

func (*CircleShape) GetRotation ¶

func (this *CircleShape) GetRotation() float32

Get the orientation of a circle shape

The rotation is always in the range [0, 360].

func (*CircleShape) GetScale ¶

func (this *CircleShape) GetScale() (scale Vector2f)

Get the current scale of a circle shape

func (*CircleShape) GetTexture ¶

func (this *CircleShape) GetTexture() *Texture

Get the source texture of a circle shape

If the shape has no source texture, nil is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.

func (*CircleShape) GetTextureRect ¶

func (this *CircleShape) GetTextureRect() (rect IntRect)

Get the sub-rectangle of the texture displayed by a circle shape

func (*CircleShape) GetTransform ¶

func (this *CircleShape) GetTransform() (transform Transform)

Get the combined transform of a circle shape

func (*CircleShape) Move ¶

func (this *CircleShape) Move(offset Vector2f)

Move a circle shape by a given offset

This function adds to the current position of the object, unlike CircleShape.SetPosition which overwrites it.

func (*CircleShape) Rotate ¶

func (this *CircleShape) Rotate(angle float32)

Rotate a circle shape

This function adds to the current rotation of the object, unlike CircleShape.SetRotation which overwrites it.

func (*CircleShape) Scale ¶

func (this *CircleShape) Scale(factor Vector2f)

Scale a circle shape

This function multiplies the current scale of the object, unlike CircleShape.SetScale which overwrites it.

func (*CircleShape) SetFillColor ¶

func (this *CircleShape) SetFillColor(color Color)

Set the fill color of a circle shape

This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sfTransparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.

func (*CircleShape) SetOrigin ¶

func (this *CircleShape) SetOrigin(orig Vector2f)

Set the local origin of a circle shape

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a circle Shape object is (0, 0).

func (*CircleShape) SetOutlineColor ¶

func (this *CircleShape) SetOutlineColor(color Color)

Set the outline color of a circle shape

You can use sfTransparent to disable the outline. By default, the shape's outline color is opaque white.

func (*CircleShape) SetOutlineThickness ¶

func (this *CircleShape) SetOutlineThickness(thickness float32)

Set the thickness of a circle shape's outline

This number cannot be negative. Using zero disables the outline. By default, the outline thickness is 0.

func (*CircleShape) SetPointCount ¶

func (this *CircleShape) SetPointCount(count uint)

Set the number of points of a circle

func (*CircleShape) SetPosition ¶

func (this *CircleShape) SetPosition(pos Vector2f)

Set the position of a circle shape

This function completely overwrites the previous position. See sfCircleShape_move to apply an offset based on the previous position instead. The default position of a circle Shape object is (0, 0).

func (*CircleShape) SetRadius ¶

func (this *CircleShape) SetRadius(radius float32)

Set the radius of a circle

func (*CircleShape) SetRotation ¶

func (this *CircleShape) SetRotation(rot float32)

Set the orientation of a circle shape

This function completely overwrites the previous rotation. See sfCircleShape_rotate to add an angle based on the previous rotation instead. The default rotation of a circle Shape object is 0.

func (*CircleShape) SetScale ¶

func (this *CircleShape) SetScale(scale Vector2f)

Set the scale factors of a circle shape

This function completely overwrites the previous scale. See sfCircleShape_scale to add a factor based on the previous scale instead. The default scale of a circle Shape object is (1, 1).

func (*CircleShape) SetTexture ¶

func (this *CircleShape) SetTexture(texture *Texture, resetRect bool)

Change the source texture of a circle shape

texture can be nil to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.

texture:   New texture
resetRect: Should the texture rect be reset to the size of the new texture?

func (*CircleShape) SetTextureRect ¶

func (this *CircleShape) SetTextureRect(rect IntRect)

Set the sub-rectangle of the texture that a circle shape will display

The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.

func (Color) Add ¶

func (this Color) Add(other Color) (newColor Color)

Component-wise saturated addition of the two colors

func (Color) Modulate ¶

func (this Color) Modulate(other Color) (newColor Color)

Component-wise multiplication of the two colors

func (*Context) SetActive ¶

func (this *Context) SetActive(active bool)

Activate or deactivate explicitely a context

active: true to activate, false to deactivate

func (*ConvexShape) Copy ¶

func (this *ConvexShape) Copy() *ConvexShape

Copy an existing convex shape

func (*ConvexShape) Draw ¶

func (this *ConvexShape) Draw(target RenderTarget, renderStates RenderStates)

Draws a convex Shape on a render target

func (*ConvexShape) GetFillColor ¶

func (this *ConvexShape) GetFillColor() (color Color)

Get the fill color of a convex shape

func (*ConvexShape) GetGlobalBounds ¶

func (this *ConvexShape) GetGlobalBounds() (rect FloatRect)

Get the global bounding rectangle of a convex shape

The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.

func (*ConvexShape) GetInverseTransform ¶

func (this *ConvexShape) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a convex shape

func (*ConvexShape) GetLocalBounds ¶

func (this *ConvexShape) GetLocalBounds() (rect FloatRect)

Get the local bounding rectangle of a convex shape

The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.

func (*ConvexShape) GetOrigin ¶

func (this *ConvexShape) GetOrigin() (origin Vector2f)

Get the local origin of a convex shape

func (*ConvexShape) GetOutlineColor ¶

func (this *ConvexShape) GetOutlineColor() (color Color)

Get the outline color of a convex shape

func (*ConvexShape) GetOutlineThickness ¶

func (this *ConvexShape) GetOutlineThickness() float32

Get the outline thickness of a convex shape

func (*ConvexShape) GetPoint ¶

func (this *ConvexShape) GetPoint(index uint) (point Vector2f)

Get a point of a convex shape

The result is undefined if index is out of the valid range.

func (*ConvexShape) GetPointCount ¶

func (this *ConvexShape) GetPointCount() uint

Get the total number of points of a convex shape

func (*ConvexShape) GetPosition ¶

func (this *ConvexShape) GetPosition() (position Vector2f)

Get the position of a convex shape

func (*ConvexShape) GetRotation ¶

func (this *ConvexShape) GetRotation() float32

Get the orientation of a convex shape

func (*ConvexShape) GetScale ¶

func (this *ConvexShape) GetScale() (scale Vector2f)

Get the current scale of a convex shape

func (*ConvexShape) GetTexture ¶

func (this *ConvexShape) GetTexture() *Texture

Get the source texture of a convex shape

If the shape has no source texture, a nil pointer is returned.

func (*ConvexShape) GetTextureRect ¶

func (this *ConvexShape) GetTextureRect() (rect IntRect)

Get the sub-rectangle of the texture displayed by a convex shape

func (*ConvexShape) GetTransform ¶

func (this *ConvexShape) GetTransform() (transform Transform)

Get the combined transform of a convex shape

func (*ConvexShape) Move ¶

func (this *ConvexShape) Move(offset Vector2f)

Move a convex shape by a given offset

This function adds to the current position of the object, unlike ConvexShape.SetPosition which overwrites it.

func (*ConvexShape) Rotate ¶

func (this *ConvexShape) Rotate(angle float32)

Rotate a convex shape

This function adds to the current rotation of the object, unlike ConvexShape.SetRotation which overwrites it.

func (*ConvexShape) Scale ¶

func (this *ConvexShape) Scale(factor Vector2f)

Scale a convex shape

This function multiplies the current scale of the object, unlike ConvexShape.SetScale which overwrites it.

func (*ConvexShape) SetFillColor ¶

func (this *ConvexShape) SetFillColor(color Color)

Set the fill color of a convex shape

This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sfTransparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.

func (*ConvexShape) SetOrigin ¶

func (this *ConvexShape) SetOrigin(orig Vector2f)

Set the local origin of a convex shape

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a circle Shape object is (0, 0).

func (*ConvexShape) SetOutlineColor ¶

func (this *ConvexShape) SetOutlineColor(color Color)

Set the outline color of a convex shape

You can use sfTransparent to disable the outline. By default, the shape's outline color is opaque white.

func (*ConvexShape) SetOutlineThickness ¶

func (this *ConvexShape) SetOutlineThickness(thickness float32)

Set the thickness of a convex shape's outline

This number cannot be negative. Using zero disables the outline. By default, the outline thickness is 0.

func (*ConvexShape) SetPoint ¶

func (this *ConvexShape) SetPoint(index uint, point Vector2f)

Set the position of a point in a convex shape

Don't forget that the polygon must remain convex, and the points need to stay ordered! SetPointCount must be called first in order to set the total number of points. The result is undefined if index is out of the valid range.

func (*ConvexShape) SetPointCount ¶

func (this *ConvexShape) SetPointCount(count uint)

Set the number of points of a convex shap

count must be greater than 2 to define a valid shape.

func (*ConvexShape) SetPosition ¶

func (this *ConvexShape) SetPosition(pos Vector2f)

Set the position of a convex shape

This function completely overwrites the previous position. See sfConvexShape_move to apply an offset based on the previous position instead. The default position of a circle Shape object is (0, 0).

func (*ConvexShape) SetRotation ¶

func (this *ConvexShape) SetRotation(rot float32)

Set the scale factors of a convex shape

This function completely overwrites the previous scale. See sfConvexShape_scale to add a factor based on the previous scale instead. The default scale of a circle Shape object is (1, 1).

func (*ConvexShape) SetScale ¶

func (this *ConvexShape) SetScale(scale Vector2f)

Set the local origin of a convex shape

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a circle Shape object is (0, 0).

func (*ConvexShape) SetTexture ¶

func (this *ConvexShape) SetTexture(texture *Texture, resetRect bool)

Change the source texture of a convex shape

The texture argument can be nil to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.

func (*ConvexShape) SetTextureRect ¶

func (this *ConvexShape) SetTextureRect(rect IntRect)

Set the sub-rectangle of the texture that a convex shape will display

The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.

func (EventClosed) Type ¶

func (EventClosed) Type() EventType

func (EventGainedFocus) Type ¶

func (EventGainedFocus) Type() EventType

func (EventJoystickButtonPressed) Type ¶

func (EventJoystickButtonPressed) Type() EventType

func (EventJoystickButtonReleased) Type ¶

func (EventJoystickButtonReleased) Type() EventType

func (EventJoystickConnected) Type ¶

func (EventJoystickConnected) Type() EventType

func (EventJoystickDisconnected) Type ¶

func (EventJoystickDisconnected) Type() EventType

func (EventJoystickMoved) Type ¶

func (EventJoystickMoved) Type() EventType

func (EventKeyPressed) Type ¶

func (EventKeyPressed) Type() EventType

func (EventKeyReleased) Type ¶

func (EventKeyReleased) Type() EventType

func (EventLostFocus) Type ¶

func (EventLostFocus) Type() EventType

func (EventMouseButtonPressed) Type ¶

func (EventMouseButtonPressed) Type() EventType

func (EventMouseButtonReleased) Type ¶

func (EventMouseButtonReleased) Type() EventType

func (EventMouseEntered) Type ¶

func (EventMouseEntered) Type() EventType

func (EventMouseLeft) Type ¶

func (EventMouseLeft) Type() EventType

func (EventMouseMoved) Type ¶

func (EventMouseMoved) Type() EventType

func (EventMouseWheelMoved) Type ¶

func (EventMouseWheelMoved) Type() EventType

func (EventResized) Type ¶

func (EventResized) Type() EventType

func (EventTextEntered) Type ¶

func (EventTextEntered) Type() EventType

func (FloatRect) Contains ¶

func (this FloatRect) Contains(x, y float32) bool

Check if a point is inside a rectangle's area

x: X coordinate of the point to test
y: Y coordinate of the point to test

func (FloatRect) Intersects ¶

func (this FloatRect) Intersects(other FloatRect) (test bool, intersection FloatRect)

Check intersection between two rectangles

other: Rectangle to test against
intersection: Overlapping rect

func (*Font) Copy ¶

func (this *Font) Copy() *Font

func (*Font) GetGlyph ¶

func (this *Font) GetGlyph(codePoint uint, characterSize uint32, bold bool) (glyph Glyph)

Retrieve a glyph of the font

codePoint:     Unicode code point of the character to get
characterSize: Reference character size
bold:          Retrieve the bold version or the regular one?

return The glyph corresponding to codePoint and characterSize

func (*Font) GetKerning ¶

func (this *Font) GetKerning(first uint32, second uint32, characterSize uint) float32

Get the kerning offset of two glyphs

The kerning is an extra offset (negative) to apply between two glyphs when rendering them, to make the pair look more "natural". For example, the pair "AV" have a special kerning to make them closer than other characters. Most of the glyphs pairs have a kerning offset of zero, though.

first:         Unicode code point of the first character
second:        Unicode code point of the second character
characterSize: Reference character size

return Kerning value for first and second, in pixels

func (*Font) GetLineSpacing ¶

func (this *Font) GetLineSpacing(characterSize uint) float32

Get the line spacing

Line spacing is the vertical offset to apply between two consecutive lines of text.

characterSize: Reference character size

return Line spacing, in pixels

func (*Font) GetTexture ¶

func (this *Font) GetTexture(characterSize uint) Texture

Retrieve the texture containing the loaded glyphs of a certain size

The contents of the returned texture changes as more glyphs are requested, thus it is not very relevant.

characterSize: Reference character size

Texture containing the glyphs of the requested size

func (*Image) Copy ¶

func (this *Image) Copy() *Image

Copy an existing image

func (*Image) CopyImage ¶

func (this *Image) CopyImage(source *Image, destX, destY uint, sourceRect IntRect, applyAlpha bool)

Copy pixels from an image onto another

This function does a slow pixel copy and should not be used intensively. It can be used to prepare a complex static image from several others, but if you need this kind of feature in real-time you'd better use RenderTexture.

If sourceRect is empty, the whole image is copied. If applyAlpha is set to true, the transparency of source pixels is applied. If it is false, the pixels are copied unchanged with their alpha value.

source:     Source image to copy
destX:      X coordinate of the destination position
destY:      Y coordinate of the destination position
sourceRect: Sub-rectangle of the source image to copy
applyAlpha: Should the copy take in account the source transparency?

func (*Image) CreateMaskFromColor ¶

func (this *Image) CreateMaskFromColor(color Color, alpha byte)

Create a transparency mask from a specified color-key

This function sets the alpha value of every pixel matching the given color to alpha (0 by default), so that they become transparent.

color: Color to make transparent
alpha: Alpha value to assign to transparent pixels

func (*Image) FlipHorizontally ¶

func (this *Image) FlipHorizontally()

Flip an image horizontally (left <-> right)

func (*Image) FlipVertically ¶

func (this *Image) FlipVertically()

Flip an image vertically (top <-> bottom)

func (*Image) GetPixel ¶

func (this *Image) GetPixel(x, y uint) (color Color)

Get the color of a pixel in an image

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

x:     X coordinate of pixel to get
y:     Y coordinate of pixel to get

func (*Image) GetPixelData ¶

func (this *Image) GetPixelData() []byte

Get a slice of pixels of an image

The length of the slice is width * height * 4 (RGBA).

func (*Image) GetSize ¶

func (this *Image) GetSize() (size Vector2u)

Return the size of an image

func (*Image) SaveToFile ¶

func (this *Image) SaveToFile(file string) error

Save an image to a file on disk

The format of the image is automatically deduced from the extension. The supported image formats are bmp, png, tga and jpg. The destination file is overwritten if it already exists. This function fails if the image is empty.

filename: Path of the file to save

func (*Image) SetPixel ¶

func (this *Image) SetPixel(x, y uint, color Color)

Change the color of a pixel in an image

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

x:     X coordinate of pixel to change
y:     Y coordinate of pixel to change
color: New color of the pixel

func (IntRect) Contains ¶

func (this IntRect) Contains(x, y int) bool

Check if a point is inside a rectangle's area

x: X coordinate of the point to test
y: Y coordinate of the point to test

func (IntRect) Intersects ¶

func (this IntRect) Intersects(other IntRect) (test bool, intersection IntRect)

Check intersection between two rectangles

other: Rectangle to test against
intersection: Overlapping rect

func (*Music) GetAttenuation ¶

func (this *Music) GetAttenuation() float32

Get the attenuation factor of a music

func (*Music) GetChannelCount ¶

func (this *Music) GetChannelCount() uint

Return the number of channels of a music

1 channel means a mono sound, 2 means stereo, etc

func (*Music) GetDuration ¶

func (this *Music) GetDuration() time.Duration

Get the total duration of a music

func (*Music) GetMinDistance ¶

func (this *Music) GetMinDistance() float32

Get the minimum distance of a music

func (*Music) GetPitch ¶

func (this *Music) GetPitch() float32

Get the pitch of a music

func (*Music) GetPlayingOffset ¶

func (this *Music) GetPlayingOffset() time.Duration

Get the current playing position of a music

func (*Music) GetPosition ¶

func (this *Music) GetPosition() (pos Vector3f)

Get the 3D position of a music in the audio scene

func (*Music) GetSampleRate ¶

func (this *Music) GetSampleRate() uint

Get the sample rate of a music

The sample rate is the number of audio samples played per second. The higher, the better the quality.

func (*Music) GetStatus ¶

func (this *Music) GetStatus() SoundStatus

Get the current status of a music (stopped, paused, playing)

func (*Music) GetVolume ¶

func (this *Music) GetVolume() float32

Get the volume of a music

func (*Music) IsRelativeToListner ¶

func (this *Music) IsRelativeToListner() bool

Tell whether a music's position is relative to the listener or is absolute

func (*Music) Pause ¶

func (this *Music) Pause()

Pause a music

This function pauses the music if it was playing, otherwise (music already paused or stopped) it has no effect.

func (*Music) Play ¶

func (this *Music) Play()

Start or resume playing a music

This function starts the music if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the music is played.

func (*Music) SetAttenuation ¶

func (this *Music) SetAttenuation(attenuation float32)

Set the attenuation factor of a music

The attenuation is a multiplicative factor which makes the music more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated music, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the music fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

attenuation: New attenuation factor of the music

func (*Music) SetLoop ¶

func (this *Music) SetLoop(loop bool)

Set whether or not a music should loop after reaching the end

If set, the music will restart from beginning after reaching the end and so on, until it is stopped or Music.SetLoop(false) is called. The default looping state for musics is false.

loop:  true to play in loop, false to play once

func (*Music) SetMinDistance ¶

func (this *Music) SetMinDistance(distance float32)

Set the minimum distance of a music

The "minimum distance" of a music is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.

distance: New minimum distance of the music

func (*Music) SetPitch ¶

func (this *Music) SetPitch(pitch float32)

Set the pitch of a music

The pitch represents the perceived fundamental frequency of a sound; thus you can make a music more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the music as well. The default value for the pitch is 1.

pitch: New pitch to apply to the music

func (*Music) SetPlayingOffset ¶

func (this *Music) SetPlayingOffset(offset time.Duration)

Change the current playing position of a music

The playing position can be changed when the music is either paused or playing.

timeOffset: New playing position

func (*Music) SetPosition ¶

func (this *Music) SetPosition(pos Vector3f)

Set the 3D position of a music in the audio scene

Only musics with one channel (mono musics) can be spatialized. The default position of a music is (0, 0, 0).

position: Position of the music in the scene

func (*Music) SetRelativeToListener ¶

func (this *Music) SetRelativeToListener(relative bool)

Make a musics's position relative to the listener or absolute

Making a music relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized musics, musics that are produced by the listener, or musics attached to it. The default value is false (position is absolute).

relative: true to set the position relative, false to set it absolute

func (*Music) SetVolume ¶

func (this *Music) SetVolume(volume float32)

Set the volume of a music

The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.

volume: Volume of the music

func (*Music) Stop ¶

func (this *Music) Stop()

Stop playing a music

This function stops the music if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike Music.Pause).

func (*RectangleShape) Copy ¶

func (this *RectangleShape) Copy() *RectangleShape

Copy an existing rectangle shape

func (*RectangleShape) Draw ¶

func (this *RectangleShape) Draw(target RenderTarget, renderStates RenderStates)

Draws a RectangleShape on a render target

func (*RectangleShape) GetFillColor ¶

func (this *RectangleShape) GetFillColor() (color Color)

Set the fill color of a rectangle shape

This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sfTransparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.

color: New color of the shape

func (*RectangleShape) GetGlobalBounds ¶

func (this *RectangleShape) GetGlobalBounds() (rect FloatRect)

Get the global bounding rectangle of a rectangle shape

The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.

func (*RectangleShape) GetInverseTransform ¶

func (this *RectangleShape) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a rectangle shape

func (*RectangleShape) GetLocalBounds ¶

func (this *RectangleShape) GetLocalBounds() (rect FloatRect)

Get the local bounding rectangle of a rectangle shape

The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.

func (*RectangleShape) GetOrigin ¶

func (this *RectangleShape) GetOrigin() (origin Vector2f)

Get the local origin of a rectangle shape

func (*RectangleShape) GetOutlineColor ¶

func (this *RectangleShape) GetOutlineColor() (color Color)

Get the outline color of a rectangle shape

func (*RectangleShape) GetOutlineThickness ¶

func (this *RectangleShape) GetOutlineThickness() float32

Get the outline thickness of a rectangle shape

func (*RectangleShape) GetPoint ¶

func (this *RectangleShape) GetPoint(index uint) (point Vector2f)

Get a point of a rectangle shape

The result is undefined if index is out of the valid range.

index: Index of the point to get, in range [0 .. GetPointCount() - 1]

func (*RectangleShape) GetPointCount ¶

func (this *RectangleShape) GetPointCount() uint

Get the total number of points of a rectangle shape

func (*RectangleShape) GetPosition ¶

func (this *RectangleShape) GetPosition() (position Vector2f)

Get the position of a rectangle shape

func (*RectangleShape) GetRotation ¶

func (this *RectangleShape) GetRotation() float32

Get the orientation of a rectangle shape

The rotation is always in the range [0, 360].

func (*RectangleShape) GetScale ¶

func (this *RectangleShape) GetScale() (scale Vector2f)

Get the current scale of a rectangle shap

func (*RectangleShape) GetSize ¶

func (this *RectangleShape) GetSize() (size Vector2f)

Get the size of a rectangle shape

func (*RectangleShape) GetTexture ¶

func (this *RectangleShape) GetTexture() *Texture

Get the source texture of a rectangle shape

If the shape has no source texture, a nil pointer is returned.

func (*RectangleShape) GetTextureRect ¶

func (this *RectangleShape) GetTextureRect() (rect IntRect)

Get the sub-rectangle of the texture displayed by a rectangle shape

func (*RectangleShape) GetTransform ¶

func (this *RectangleShape) GetTransform() (transform Transform)

Get the combined transform of a rectangle shape

func (*RectangleShape) Move ¶

func (this *RectangleShape) Move(offset Vector2f)

Move a rectangle shape by a given offset

This function adds to the current position of the object, unlike RectangleShape.SetPosition which overwrites it.

func (*RectangleShape) Rotate ¶

func (this *RectangleShape) Rotate(angle float32)

Rotate a rectangle shape

This function adds to the current rotation of the object, unlike RectangleShape.SetRotation which overwrites it.

func (*RectangleShape) Scale ¶

func (this *RectangleShape) Scale(factor Vector2f)

Scale a rectangle shape

This function multiplies the current scale of the object, unlike RectangleShape.SetScale which overwrites it.

func (*RectangleShape) SetFillColor ¶

func (this *RectangleShape) SetFillColor(color Color)

Set the fill color of a rectangle shape

This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sfTransparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.

color: New color of the shape

func (*RectangleShape) SetOrigin ¶

func (this *RectangleShape) SetOrigin(orig Vector2f)

Set the local origin of a rectangle shape

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a circle Shape object is (0, 0).

origin: New origin

func (*RectangleShape) SetOutlineColor ¶

func (this *RectangleShape) SetOutlineColor(color Color)

Set the outline color of a rectangle shape

You can use sfTransparent to disable the outline. By default, the shape's outline color is opaque white.

color: New outline color of the shape

func (*RectangleShape) SetOutlineThickness ¶

func (this *RectangleShape) SetOutlineThickness(thickness float32)

Set the thickness of a rectangle shape's outline

This number cannot be negative. Using zero disables the outline. By default, the outline thickness is 0.

thickness: New outline thickness

func (*RectangleShape) SetPosition ¶

func (this *RectangleShape) SetPosition(pos Vector2f)

Set the position of a rectangle shape

This function completely overwrites the previous position. See sfRectangleShape_move to apply an offset based on the previous position instead. The default position of a circle Shape object is (0, 0).

position: New position

func (*RectangleShape) SetRotation ¶

func (this *RectangleShape) SetRotation(rot float32)

Set the orientation of a rectangle shape

This function completely overwrites the previous rotation. See sfRectangleShape_rotate to add an angle based on the previous rotation instead. The default rotation of a circle Shape object is 0.

angle: New rotation, in degrees

func (*RectangleShape) SetScale ¶

func (this *RectangleShape) SetScale(scale Vector2f)

Set the scale factors of a rectangle shape

This function completely overwrites the previous scale. See sfRectangleShape_scale to add a factor based on the previous scale instead. The default scale of a circle Shape object is (1, 1).

scale: New scale factors

func (*RectangleShape) SetSize ¶

func (this *RectangleShape) SetSize(size Vector2f)

Set the size of a rectangle shape

func (*RectangleShape) SetTexture ¶

func (this *RectangleShape) SetTexture(texture *Texture, resetRect bool)

Change the source texture of a rectangle shape

texture can be nil to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.

texture:   New texture
resetRect: Should the texture rect be reset to the size of the new texture?

func (*RectangleShape) SetTextureRect ¶

func (this *RectangleShape) SetTextureRect(rect IntRect)

Set the sub-rectangle of the texture that a rectangle shape will display

The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.

rect:  Rectangle defining the region of the texture to display

func (*RenderTexture) Clear ¶

func (this *RenderTexture) Clear(color Color)

Clear the rendertexture with the given color

color: Fill color

func (*RenderTexture) Display ¶

func (this *RenderTexture) Display()

Update the contents of the target texture

func (*RenderTexture) Draw ¶

func (this *RenderTexture) Draw(drawer Drawer, renderStates RenderStates)

Draws a RectangleShape on a render target

func (*RenderTexture) DrawPrimitives ¶

func (this *RenderTexture) DrawPrimitives(vertices []Vertex, primType PrimitiveType, renderStates RenderStates)

Draw primitives defined by a slice of vertices

func (*RenderTexture) GetDefaultView ¶

func (this *RenderTexture) GetDefaultView() *View

Get the default view of a render texture

func (*RenderTexture) GetSize ¶

func (this *RenderTexture) GetSize() (size Vector2u)

Get the size of the rendering region of a render texture

func (*RenderTexture) GetTexture ¶

func (this *RenderTexture) GetTexture() *Texture

Get the target texture of a render texture

func (*RenderTexture) GetView ¶

func (this *RenderTexture) GetView() *View

Get the current active view of a render texture

func (*RenderTexture) GetViewport ¶

func (this *RenderTexture) GetViewport(view *View) (viewport IntRect)

Get the viewport of a view applied to this target

view: Target view

func (*RenderTexture) IsRepeated ¶

func (this *RenderTexture) IsRepeated() bool

Tell whether the texture is repeated or not

func (*RenderTexture) IsSmooth ¶

func (this *RenderTexture) IsSmooth() bool

Tell whether the smooth filter is enabled or not for a render texture

func (*RenderTexture) MapCoordsToPixel ¶

func (this *RenderTexture) MapCoordsToPixel(pos Vector2f, view *View) (coords Vector2i)

Convert a point from world coordinates to texture coordinates

This function finds the pixel of the render-texture that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.

Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-texture, this assertion is not true anymore, ie. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render-texture -- if the view is translated by (140, 25).

This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-texture.

point: Point to convert
view:  The view to use for converting the point

func (*RenderTexture) MapPixelToCoords ¶

func (this *RenderTexture) MapPixelToCoords(pos Vector2i, view *View) (coords Vector2f)

Convert a point from texture coordinates to world coordinates

This function finds the 2D position that matches the given pixel of the render-texture. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.

Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-texture, this assertion is not true anymore, ie. a point located at (10, 50) in your render-texture may map to the point (150, 75) in your 2D world -- if the view is translated by (140, 25).

This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-texture.

point: Pixel to convert
view:  The view to use for converting the point

func (*RenderTexture) PopGLStates ¶

func (this *RenderTexture) PopGLStates()

Restore the previously saved OpenGL render states and matrices

See the description of pushGLStates to get a detailed description of these functions.

func (*RenderTexture) PushGLStates ¶

func (this *RenderTexture) PushGLStates()

Save the current OpenGL render states and matrices

This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with popGLStates, it ensures that: SFML's internal states are not messed up by your OpenGL code your OpenGL states are not modified by a call to a SFML function

Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the resetGLStates function if you do so.

func (*RenderTexture) ResetGLStates ¶

func (this *RenderTexture) ResetGLStates()

Reset the internal OpenGL states so that the target is ready for drawing

This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use pushGLStates/popGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent RenderTexture.Draw calls will work as expected.

func (*RenderTexture) SetActive ¶

func (this *RenderTexture) SetActive(active bool)

Activate or deactivate a render texture as the current target for rendering

active: true to activate, false to deactivate

func (*RenderTexture) SetRepeated ¶

func (this *RenderTexture) SetRepeated(repeated bool)

Enable or disable texture repeating

repeated: true to enable repeating, false to disable it

func (*RenderTexture) SetSmooth ¶

func (this *RenderTexture) SetSmooth(smooth bool)

Enable or disable the smooth filter on a render texture

smooth: true to enable smoothing, false to disable it

func (*RenderTexture) SetView ¶

func (this *RenderTexture) SetView(view *View)

Change the current active view of a render texture

view: Pointer to the new view

func (*RenderWindow) Capture ¶

func (this *RenderWindow) Capture() *Image

Copy the current contents of a render window to an image

his is a slow operation, whose main purpose is to make screenshots of the application. If you want to update an image with the contents of the window and then use it for drawing, you should rather use a sfTexture and its update(sfWindow*) function. You can also draw things directly to a texture with the sfRenderWindow class.

return New image containing the captured contents

func (*RenderWindow) Clear ¶

func (this *RenderWindow) Clear(color Color)

Clear a render window with the given color

color: Fill color

func (*RenderWindow) Close ¶

func (this *RenderWindow) Close()

Close a render window (but doesn't destroy the internal data)

func (*RenderWindow) Display ¶

func (this *RenderWindow) Display()

Display a render window on screen

func (*RenderWindow) Draw ¶

func (this *RenderWindow) Draw(drawer Drawer, renderStates RenderStates)

Draw a drawable object to the render-target

func (*RenderWindow) DrawPrimitives ¶

func (this *RenderWindow) DrawPrimitives(vertices []Vertex, primType PrimitiveType, renderStates RenderStates)

Draw primitives defined by a slice of vertices

func (*RenderWindow) GetDefaultView ¶

func (this *RenderWindow) GetDefaultView() *View

Get the default view of a render window

func (*RenderWindow) GetPosition ¶

func (this *RenderWindow) GetPosition() (pos Vector2i)

Get the position of a render window

func (*RenderWindow) GetSettings ¶

func (this *RenderWindow) GetSettings() (settings ContextSettings)

Get the creation settings of a render window

func (*RenderWindow) GetSize ¶

func (this *RenderWindow) GetSize() (size Vector2u)

Get the size of the rendering region of a render window

func (*RenderWindow) GetView ¶

func (this *RenderWindow) GetView() *View

Get the current active view of a render window

func (*RenderWindow) GetViewport ¶

func (this *RenderWindow) GetViewport(view *View) (viewport IntRect)

Get the viewport of a view applied to this target

view: Target view

func (*RenderWindow) HasFocus ¶

func (this *RenderWindow) HasFocus() bool

Check whether the render window has the input focus

At any given time, only one window may have the input focus to receive input events such as keystrokes or most mouse events.

True if window has focus, false otherwise

func (*RenderWindow) IsOpen ¶

func (this *RenderWindow) IsOpen() bool

Tell whether or not a render window is opened

func (*RenderWindow) MapCoordsToPixel ¶

func (this *RenderWindow) MapCoordsToPixel(pos Vector2f, view *View) (coords Vector2i)

Convert a point from world coordinates to window coordinates

This function finds the pixel of the render-window that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.

Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-window, this assertion is not true anymore, ie. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render-window -- if the view is translated by (140, 25).

This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-window.

point Point to convert
view The view to use for converting the point

return The converted point, in target coordinates (pixels)

func (*RenderWindow) MapPixelToCoords ¶

func (this *RenderWindow) MapPixelToCoords(pos Vector2i, view *View) (coords Vector2f)

Convert a point from window coordinates to world coordinates

This function finds the 2D position that matches the given pixel of the render-window. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.

Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-window, this assertion is not true anymore, ie. a point located at (10, 50) in your render-window may map to the point (150, 75) in your 2D world -- if the view is translated by (140, 25).

This function is typically used to find which point (or object) is located below the mouse cursor.

This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-window.

point: Pixel to convert
view:  The view to use for converting the point

return The converted point, in "world" units

func (*RenderWindow) PollEvent ¶

func (this *RenderWindow) PollEvent() Event

Get the event on top of event queue of a render window, if any, and pop it

returns nil if there are no events left.

func (*RenderWindow) PopGLStates ¶

func (this *RenderWindow) PopGLStates()

Restore the previously saved OpenGL render states and matrices

See the description of pushGLStates to get a detailed description of these functions.

func (*RenderWindow) PushGLStates ¶

func (this *RenderWindow) PushGLStates()

Save the current OpenGL render states and matrices

This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with PopGLStates, it ensures that: SFML's internal states are not messed up by your OpenGL code your OpenGL states are not modified by a call to a SFML function

Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the ResetGLStates function if you do so.

func (*RenderWindow) RequestFocus ¶

func (this *RenderWindow) RequestFocus()

Request the current render window to be made the active foreground window

At any given time, only one window may have the input focus to receive input events such as keystrokes or mouse events. If a window requests focus, it only hints to the operating system, that it would like to be focused. The operating system is free to deny the request. This is not to be confused with RenderWindow.SetActive().

func (*RenderWindow) ResetGLStates ¶

func (this *RenderWindow) ResetGLStates()

Reset the internal OpenGL states so that the target is ready for drawing

This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use PushGLStates/PopGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent RenderWindow.Draw calls will work as expected.

func (*RenderWindow) SetActive ¶

func (this *RenderWindow) SetActive(active bool) bool

Activate or deactivate a render window as the current target for rendering

active: true to activate, false to deactivate

return True if operation was successful, false otherwise

func (*RenderWindow) SetFramerateLimit ¶

func (this *RenderWindow) SetFramerateLimit(limit uint)

Limit the framerate to a maximum fixed frequency for a render window

limit: Framerate limit, in frames per seconds (use 0 to disable limit)

func (*RenderWindow) SetIcon ¶

func (this *RenderWindow) SetIcon(width, height uint, data []byte) error

Change a render window's icon

width:  Icon's width, in pixels
height: Icon's height, in pixels
pixels: Slice of pixels, format must be RGBA 32 bits

func (*RenderWindow) SetJoystickThreshold ¶

func (this *RenderWindow) SetJoystickThreshold(threshold float32)

Change the joystick threshold, ie. the value below which no move event will be generated

threshold: New threshold, in range [0, 100]

func (*RenderWindow) SetKeyRepeatEnabled ¶

func (this *RenderWindow) SetKeyRepeatEnabled(enabled bool)

Enable or disable automatic key-repeat

If key repeat is enabled, you will receive repeated KeyPress events while keeping a key pressed. If it is disabled, you will only get a single event when the key is pressed.

Key repeat is enabled by default.

func (*RenderWindow) SetMouseCursorVisible ¶

func (this *RenderWindow) SetMouseCursorVisible(visible bool)

Show or hide the mouse cursor on a render window

visible: true to show, false to hide

func (*RenderWindow) SetPosition ¶

func (this *RenderWindow) SetPosition(pos Vector2i)

Change the position of a render window on screen

Only works for top-level windows

pos: New position, in pixels

func (*RenderWindow) SetSize ¶

func (this *RenderWindow) SetSize(size Vector2u)

Change the size of the rendering region of a render window

size: New size, in pixels

func (*RenderWindow) SetTitle ¶

func (this *RenderWindow) SetTitle(title string)

Change the title of a render window

title: New title

func (*RenderWindow) SetVSyncEnabled ¶

func (this *RenderWindow) SetVSyncEnabled(enabled bool)

Enable / disable vertical synchronization on a render window

enabled: true to enable v-sync, false to deactivate

func (*RenderWindow) SetView ¶

func (this *RenderWindow) SetView(view *View)

Change the current active view of a render window

view: Pointer to the new view

func (*RenderWindow) SetVisible ¶

func (this *RenderWindow) SetVisible(visible bool)

Show or hide a render window

visible: true to show the window, false to hide it

func (*RenderWindow) WaitEvent ¶

func (this *RenderWindow) WaitEvent() Event

Wait for an event and return it

func (*Shader) SetColorParameter ¶

func (this *Shader) SetColorParameter(name string, color Color)

Change a color parameter of a shader

name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a 4x1 vector (vec4 GLSL type).

It is important to note that the components of the color are normalized before being passed to the shader. Therefore, they are converted from range [0 .. 255] to range [0 .. 1]. For example, a sf::Color(255, 125, 0, 255) will be transformed to a vec4(1.0, 0.5, 0.0, 1.0) in the shader.

name:   Name of the parameter in the shader
color:  Color to assign

func (*Shader) SetCurrentTextureParameter ¶

func (this *Shader) SetCurrentTextureParameter(name string)

Change a texture parameter of a shader

This function maps a shader texture variable to the texture of the object being drawn, which cannot be known in advance. The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).

name:   Name of the texture in the shader

func (*Shader) SetFloatParameter ¶

func (this *Shader) SetFloatParameter(name string, data ...float32)

Change a n-components vector parameter of a shader

name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a n x 1 vector with n = 1 ... 4.

func (*Shader) SetTextureParameter ¶

func (this *Shader) SetTextureParameter(name string, texture *Texture)

Change a texture parameter of a shader

name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).

name:    Name of the texture in the shader
texture: Texture to assign

func (*Shader) SetTransformParameter ¶

func (this *Shader) SetTransformParameter(name string, trans Transform)

Change a matrix parameter of a shader

name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a 4x4 matrix (mat4 GLSL type).

name:      Name of the parameter in the shader
transform: Transform to assign

func (*Sound) Copy ¶

func (this *Sound) Copy() *Sound

Create a new sound by copying an existing one

func (*Sound) GetAttenuation ¶

func (this *Sound) GetAttenuation() float32

Get the attenuation factor of a sound

func (*Sound) GetBuffer ¶

func (this *Sound) GetBuffer() *SoundBuffer

Get the audio buffer attached to a sound

func (*Sound) GetLoop ¶

func (this *Sound) GetLoop() bool

Tell whether or not a sound is in loop mode

func (*Sound) GetMinDistance ¶

func (this *Sound) GetMinDistance() float32

Get the minimum distance of a sound

func (*Sound) GetPitch ¶

func (this *Sound) GetPitch() float32

Get the pitch of a sound

func (*Sound) GetPlayingOffset ¶

func (this *Sound) GetPlayingOffset() time.Duration

Get the current playing position of a sound

func (*Sound) GetPosition ¶

func (this *Sound) GetPosition() (pos Vector3f)

Get the 3D position of a sound in the audio scene

func (*Sound) GetStatus ¶

func (this *Sound) GetStatus() SoundStatus

Get the current status of a sound (stopped, paused, playing)

func (*Sound) GetVolume ¶

func (this *Sound) GetVolume() float32

Get the volume of a sound

func (*Sound) IsRelativeToListner ¶

func (this *Sound) IsRelativeToListner() bool

Tell whether a sound's position is relative to the listener or is absolute

func (*Sound) Pause ¶

func (this *Sound) Pause()

Pause a sound

This function pauses the sound if it was playing, otherwise (sound already paused or stopped) it has no effect.

func (*Sound) Play ¶

func (this *Sound) Play()

Start or resume playing a sound

This function starts the sound if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the sound is played.

func (*Sound) SetAttenuation ¶

func (this *Sound) SetAttenuation(attenuation float32)

Set the attenuation factor of a sound

The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

func (*Sound) SetBuffer ¶

func (this *Sound) SetBuffer(buffer *SoundBuffer)

Set the source buffer containing the audio data to play

func (*Sound) SetLoop ¶

func (this *Sound) SetLoop(loop bool)

Set whether or not a sound should loop after reaching the end

If set, the sound will restart from beginning after reaching the end and so on, until it is stopped or Sound.SetLoop(false) is called. The default looping state for sounds is false.

func (*Sound) SetMinDistance ¶

func (this *Sound) SetMinDistance(distance float32)

Set the minimum distance of a sound

The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.

func (*Sound) SetPitch ¶

func (this *Sound) SetPitch(pitch float32)

Set the pitch of a sound

The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.

func (*Sound) SetPlayingOffset ¶

func (this *Sound) SetPlayingOffset(offset time.Duration)

Change the current playing position of a sound

The playing position can be changed when the sound is either paused or playing.

func (*Sound) SetPosition ¶

func (this *Sound) SetPosition(pos Vector3f)

Set the 3D position of a sound in the audio scene

Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).

func (*Sound) SetRelativeToListener ¶

func (this *Sound) SetRelativeToListener(relative bool)

Make the sound's position relative to the listener or absolute

Making a sound relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).

func (*Sound) SetVolume ¶

func (this *Sound) SetVolume(volume float32)

Set the volume of a sound

The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.

func (*Sound) Stop ¶

func (this *Sound) Stop()

Stop playing a sound

This function stops the sound if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike Sound.Pause).

func (*SoundBuffer) Copy ¶

func (this *SoundBuffer) Copy() *SoundBuffer

Create a new sound buffer by copying an existing one

func (*SoundBuffer) GetChannelCount ¶

func (this *SoundBuffer) GetChannelCount() uint

Get the number of channels used by a sound buffer

If the sound is mono then the number of channels will be 1, 2 for stereo, etc.

func (*SoundBuffer) GetDuration ¶

func (this *SoundBuffer) GetDuration() time.Duration

Get the total duration of a sound buffer

func (*SoundBuffer) GetSampleCount ¶

func (this *SoundBuffer) GetSampleCount() uint

Get the number of samples stored in a sound buffer

The array of samples can be accessed with the SoundBuffer.GetSamples function.

func (*SoundBuffer) GetSampleRate ¶

func (this *SoundBuffer) GetSampleRate() uint

Get the sample rate of a sound buffer

The sample rate is the number of samples played per second. The higher, the better the quality (for example, 44100 samples/s is CD quality).

func (*SoundBuffer) GetSamples ¶

func (this *SoundBuffer) GetSamples() []int16

Get the slice of audio samples stored in a sound buffer

The format of the returned samples is 16 bits signed integer (int16).

func (*SoundBuffer) SaveToFile ¶

func (this *SoundBuffer) SaveToFile(file string) error

Save a sound buffer to an audio file

Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.

file: Path of the sound file to write

func (*SoundBufferRecorder) GetBuffer ¶

func (this *SoundBufferRecorder) GetBuffer() *SoundBuffer

Get the sound buffer containing the captured audio data

The sound buffer is valid only after the capture has ended.

func (*SoundBufferRecorder) GetSampleRate ¶

func (this *SoundBufferRecorder) GetSampleRate() uint

Get the sample rate of a sound buffer recorder

The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).

func (*SoundBufferRecorder) Start ¶

func (this *SoundBufferRecorder) Start(sampleRate uint)

Start the capture of a sound recorder recorder

The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time.

soundBufferRecorder Sound buffer recorder object
sampleRate          Desired capture rate, in number of samples per second

func (*SoundBufferRecorder) Stop ¶

func (this *SoundBufferRecorder) Stop()

Stop the capture of a sound recorder

func (*SoundRecorder) GetSampleRate ¶

func (this *SoundRecorder) GetSampleRate() uint

Get the sample rate of a sound recorder

The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).

func (*SoundRecorder) SetProcessingInterval ¶

func (this *SoundRecorder) SetProcessingInterval(interval time.Duration)

Set the processing interval

The processing interval controls the period between calls to the onProcessSamples function. You may want to use a small interval if you want to process the recorded data in real time, for example.

Note: this is only a hint, the actual period may vary. So don't rely on this parameter to implement precise timing.

The default processing interval is 100 ms.

interval Processing interval

func (*SoundRecorder) Start ¶

func (this *SoundRecorder) Start(sampleRate uint)

The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time.

sampleRate    Desired capture rate, in number of samples per second

func (*SoundRecorder) Stop ¶

func (this *SoundRecorder) Stop()

Stop the capture of a sound recorder

func (*SoundStream) GetAttenuation ¶

func (this *SoundStream) GetAttenuation() float32

Get the attenuation factor of a sound stream

func (*SoundStream) GetChannelCount ¶

func (this *SoundStream) GetChannelCount() uint

Return the number of channels of a sound stream

1 channel means a mono sound, 2 means stereo, etc.

func (*SoundStream) GetLoop ¶

func (this *SoundStream) GetLoop() bool

Tell whether or not a sound stream is in loop mode

func (*SoundStream) GetMinDistance ¶

func (this *SoundStream) GetMinDistance() float32

Get the minimum distance of a sound stream

func (*SoundStream) GetPitch ¶

func (this *SoundStream) GetPitch() float32

Get the pitch of a sound stream

func (*SoundStream) GetPlayingOffset ¶

func (this *SoundStream) GetPlayingOffset() time.Duration

Get the current playing position of a sound stream

func (*SoundStream) GetPosition ¶

func (this *SoundStream) GetPosition() (pos Vector3f)

Get the 3D position of a sound stream in the audio scene

func (*SoundStream) GetSampleRate ¶

func (this *SoundStream) GetSampleRate() uint

Get the sample rate of a sound stream

The sample rate is the number of audio samples played per second. The higher, the better the quality.

func (*SoundStream) GetStatus ¶

func (this *SoundStream) GetStatus() SoundStatus

Get the current status of a sound stream (stopped, paused, playing)

func (*SoundStream) GetVolume ¶

func (this *SoundStream) GetVolume() float32

Get the volume of a sound stream, in the range [0, 100]

func (*SoundStream) IsRelativeToListener ¶

func (this *SoundStream) IsRelativeToListener() bool

Tell whether a sound stream's position is relative to the listener or is absolute

func (*SoundStream) Pause ¶

func (this *SoundStream) Pause()

Pause a sound stream

This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.

func (*SoundStream) Play ¶

func (this *SoundStream) Play()

Start or resume playing a sound stream

This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the music is played.

func (*SoundStream) SetAttenuation ¶

func (this *SoundStream) SetAttenuation(attenuation float32)

Set the attenuation factor of a sound stream

The attenuation is a multiplicative factor which makes the stream more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated stream, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the stream fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

func (*SoundStream) SetLoop ¶

func (this *SoundStream) SetLoop(loop bool)

Set whether or not a sound stream should loop after reaching the end

If set, the stream will restart from beginning after reaching the end and so on, until it is stopped or SoundStream.SetLoop(false) is called. The default looping state for sound streams is false.

func (*SoundStream) SetMinDistance ¶

func (this *SoundStream) SetMinDistance(distance float32)

Set the minimum distance of a sound stream

The "minimum distance" of a stream is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.

func (*SoundStream) SetPitch ¶

func (this *SoundStream) SetPitch(pitch float32)

Set the pitch of a sound stream

The pitch represents the perceived fundamental frequency of a sound; thus you can make a stream more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the stream as well. The default value for the pitch is 1.

func (*SoundStream) SetPlayingOffset ¶

func (this *SoundStream) SetPlayingOffset(offset time.Duration)

Change the current playing position of a sound stream

The playing position can be changed when the stream is either paused or playing.

func (*SoundStream) SetPosition ¶

func (this *SoundStream) SetPosition(position Vector3f)

Set the 3D position of a sound stream in the audio scene

Only streams with one channel (mono streams) can be spatialized. The default position of a stream is (0, 0, 0).

func (*SoundStream) SetRelativeToListener ¶

func (this *SoundStream) SetRelativeToListener(relative bool)

Make a sound stream's position relative to the listener or absolute

Making a stream relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized streams, streams that are produced by the listener, or streams attached to it. The default value is false (position is absolute).

func (*SoundStream) SetVolume ¶

func (this *SoundStream) SetVolume(volume float32)

Set the volume of a sound stream

The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.

func (*SoundStream) Stop ¶

func (this *SoundStream) Stop()

Stop playing a sound stream

This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike SoundStream.Pause).

func (*Sprite) Copy ¶

func (this *Sprite) Copy() *Sprite

Copy an existing sprite

func (*Sprite) Draw ¶

func (this *Sprite) Draw(target RenderTarget, renderStates RenderStates)

Draws a RectangleShape on a render target

func (*Sprite) GetColor ¶

func (this *Sprite) GetColor() (color Color)

Get the global color of a sprite

func (*Sprite) GetGlobalBounds ¶

func (this *Sprite) GetGlobalBounds() (rect FloatRect)

Get the global bounding rectangle of a sprite

The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.

func (*Sprite) GetInverseTransform ¶

func (this *Sprite) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a sprite

func (*Sprite) GetLocalBounds ¶

func (this *Sprite) GetLocalBounds() (rect FloatRect)

Get the local bounding rectangle of a sprite

The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.

func (*Sprite) GetOrigin ¶

func (this *Sprite) GetOrigin() (origin Vector2f)

Get the local origin of a sprite

func (*Sprite) GetPosition ¶

func (this *Sprite) GetPosition() (pos Vector2f)

Get the position of a sprite

func (*Sprite) GetRotation ¶

func (this *Sprite) GetRotation() float32

Get the orientation of a sprite

The rotation is always in the range [0, 360].

func (*Sprite) GetScale ¶

func (this *Sprite) GetScale() (scale Vector2f)

Get the current scale of a sprite

func (*Sprite) GetTexture ¶

func (this *Sprite) GetTexture() *Texture

Get the source texture of a sprite

If the sprite has no source texture, nil is returned.

func (*Sprite) GetTextureRect ¶

func (this *Sprite) GetTextureRect() (rect IntRect)

Get the sub-rectangle of the texture displayed by a sprite

func (*Sprite) GetTransform ¶

func (this *Sprite) GetTransform() (trans Transform)

Get the combined transform of a sprite

func (*Sprite) Move ¶

func (this *Sprite) Move(offset Vector2f)

Move a sprite by a given offset

This function adds to the current position of the object, unlike Sprite.SetPosition which overwrites it.

func (*Sprite) Rotate ¶

func (this *Sprite) Rotate(angle float32)

Rotate a sprite

This function adds to the current rotation of the object, unlike Sprite.SetRotation which overwrites it.

func (*Sprite) Scale ¶

func (this *Sprite) Scale(factor Vector2f)

Scale a sprite

This function multiplies the current scale of the object, unlike Sprite.SetScale which overwrites it.

func (*Sprite) SetColor ¶

func (this *Sprite) SetColor(color Color)

Set the global color of a sprite

This color is modulated (multiplied) with the sprite's texture. It can be used to colorize the sprite, or change its global opacity. By default, the sprite's color is opaque white.

func (*Sprite) SetOrigin ¶

func (this *Sprite) SetOrigin(orig Vector2f)

Set the local origin of a sprite

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a sprite Sprite object is (0, 0).

func (*Sprite) SetPosition ¶

func (this *Sprite) SetPosition(pos Vector2f)

Set the position of a sprite

This function completely overwrites the previous position. See Sprite.Move to apply an offset based on the previous position instead. The default position of a sprite Sprite object is (0, 0).

func (*Sprite) SetRotation ¶

func (this *Sprite) SetRotation(rot float32)

Set the orientation of a sprite

This function completely overwrites the previous rotation. See Sprite.Rotate to add an angle based on the previous rotation instead. The default rotation of a sprite Sprite object is 0.

func (*Sprite) SetScale ¶

func (this *Sprite) SetScale(scale Vector2f)

Set the scale factors of a sprite

This function completely overwrites the previous scale. See sfSprite_scale to add a factor based on the previous scale instead. The default scale of a sprite Sprite object is (1, 1).

func (*Sprite) SetTexture ¶

func (this *Sprite) SetTexture(texture *Texture, resetRect bool)

Change the source texture of a sprite

The texture argument refers to a texture that must exist as long as the sprite uses it. Indeed, the sprite doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the sprite tries to use it, the behaviour is undefined. If resetRect is true, the TextureRect property of the sprite is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.

texture:   New texture
resetRect: Should the texture rect be reset to the size of the new texture?

func (*Sprite) SetTextureRect ¶

func (this *Sprite) SetTextureRect(rect IntRect)

Set the sub-rectangle of the texture that a sprite will display

The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.

rect: Rectangle defining the region of the texture to display

func (*Text) Copy ¶

func (this *Text) Copy() *Text

Copy an existing text

func (*Text) Draw ¶

func (this *Text) Draw(target RenderTarget, renderStates RenderStates)

Draws a Text on a render target

func (*Text) FindCharacterPos ¶

func (this *Text) FindCharacterPos(index uint) (pos Vector2f)

Return the position of the index-th character in a text

This function computes the visual position of a character from its index in the string. The returned position is in global coordinates (translation, rotation, scale and origin are applied). If index is out of range, the position of the end of the string is returned.

func (*Text) GetCharacterSize ¶

func (this *Text) GetCharacterSize() uint

Get the size of the characters of a text

func (*Text) GetColor ¶

func (this *Text) GetColor() (color Color)

Get the global color of a text

func (*Text) GetFont ¶

func (this *Text) GetFont() *Font

Get the font used by a text

If the text has no font attached, a nil pointer is returned.

func (*Text) GetGlobalBounds ¶

func (this *Text) GetGlobalBounds() (rect FloatRect)

Get the global bounding rectangle of a text

The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the text in the global 2D world's coordinate system.

func (*Text) GetInverseTransform ¶

func (this *Text) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a text

func (*Text) GetLocalBounds ¶

func (this *Text) GetLocalBounds() (rect FloatRect)

Get the local bounding rectangle of a text

The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.

func (*Text) GetOrigin ¶

func (this *Text) GetOrigin() (origin Vector2f)

Get the local origin of a text

func (*Text) GetPosition ¶

func (this *Text) GetPosition() (pos Vector2f)

Get the position of a text

func (*Text) GetRotation ¶

func (this *Text) GetRotation() float32

Get the orientation of a text

The rotation is always in the range [0, 360].

func (*Text) GetScale ¶

func (this *Text) GetScale() (scale Vector2f)

Get the current scale of a text

func (*Text) GetString ¶

func (this *Text) GetString() string

Get the string of a text (returns a unicode string)

func (*Text) GetStyle ¶

func (this *Text) GetStyle() TextStyle

Get the style of a text

func (*Text) GetTransform ¶

func (this *Text) GetTransform() (trans Transform)

Get the combined transform of a text

func (*Text) Move ¶

func (this *Text) Move(offset Vector2f)

Move a text by a given offset

This function adds to the current position of the object, unlike Text.SetPosition which overwrites it.

offset: Offset

func (*Text) Rotate ¶

func (this *Text) Rotate(angle float32)

Rotate a text

This function adds to the current rotation of the object, unlike Text.SetRotation which overwrites it.

angle: Angle of rotation, in degrees

func (*Text) Scale ¶

func (this *Text) Scale(factor Vector2f)

Scale a text

This function multiplies the current scale of the object, unlike Text.SetScale which overwrites it.

factor: Scale factors

func (*Text) SetCharacterSize ¶

func (this *Text) SetCharacterSize(size uint)

Set the character size of a text

The default size is 30.

func (*Text) SetColor ¶

func (this *Text) SetColor(color Color)

Set the global color of a text

By default, the text's color is opaque white.

func (*Text) SetFont ¶

func (this *Text) SetFont(font *Font)

Set the font of a text

func (*Text) SetOrigin ¶

func (this *Text) SetOrigin(orig Vector2f)

Set the local origin of a text

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a text object is (0, 0).

origin: New origin

func (*Text) SetPosition ¶

func (this *Text) SetPosition(pos Vector2f)

Set the position of a text

This function completely overwrites the previous position. See Text.Move to apply an offset based on the previous position instead. The default position of a text Text object is (0, 0).

position: New position

func (*Text) SetRotation ¶

func (this *Text) SetRotation(rot float32)

Set the orientation of a text

This function completely overwrites the previous rotation. See sfText_rotate to add an angle based on the previous rotation instead. The default rotation of a text Text object is 0.

rot: New rotation, in degrees

func (*Text) SetScale ¶

func (this *Text) SetScale(scale Vector2f)

Set the scale factors of a text

This function completely overwrites the previous scale. See Text.Scale to add a factor based on the previous scale instead. The default scale of a text Text object is (1, 1).

scale: New scale factors

func (*Text) SetString ¶

func (this *Text) SetString(text string)

Set the string of a text (from a unicode string)

func (*Text) SetStyle ¶

func (this *Text) SetStyle(style TextStyle)

Set the style of a text

You can pass a combination of one or more styles, for example TextBold | TextItalic. The default style is TextRegular.

func (*Texture) Copy ¶

func (this *Texture) Copy() *Texture

Copy an existing texture

func (*Texture) CopyToImage ¶

func (this *Texture) CopyToImage() *Image

Copy a texture's pixels to an image

func (*Texture) GetSize ¶

func (this *Texture) GetSize() (size Vector2u)

Return the size of the texture

func (*Texture) IsRepeated ¶

func (this *Texture) IsRepeated() bool

Tell whether a texture is repeated or not

func (*Texture) IsSmooth ¶

func (this *Texture) IsSmooth() bool

Tell whether the smooth filter is enabled or not for a texture

func (*Texture) SetRepeated ¶

func (this *Texture) SetRepeated(repeated bool)

Enable or disable repeating for a texture

Repeating is involved when using texture coordinates outside the texture rectangle [0, 0, width, height]. In this case, if repeat mode is enabled, the whole texture will be repeated as many times as needed to reach the coordinate (for example, if the X texture coordinate is 3 * width, the texture will be repeated 3 times). If repeat mode is disabled, the "extra space" will instead be filled with border pixels. Warning: on very old graphics cards, white pixels may appear when the texture is repeated. With such cards, repeat mode can be used reliably only if the texture has power-of-two dimensions (such as 256x128). Repeating is disabled by default.

func (*Texture) SetSmooth ¶

func (this *Texture) SetSmooth(smooth bool)

Enable or disable the smooth filter on a texture

func (*Texture) UpdateFromImage ¶

func (this *Texture) UpdateFromImage(image *Image, x, y uint)

Update a texture from an image

image:   Image to copy to the texture
x:       X offset in the texture where to copy the source pixels
y:       Y offset in the texture where to copy the source pixels

func (*Texture) UpdateFromPixels ¶

func (this *Texture) UpdateFromPixels(pixels []byte, width, height, x, y uint)

Update a texture from an array of pixels

pixels:  Slice of pixels to copy to the texture
width:   Width of the pixel region contained in pixels
height:  Height of the pixel region contained in pixels
x:       X offset in the texture where to copy the source pixels
y:       Y offset in the texture where to copy the source pixels

func (*Texture) UpdateFromRenderWindow ¶

func (this *Texture) UpdateFromRenderWindow(window *RenderWindow, x, y uint)

Update a texture from the contents of a render-window

renderWindow: Render-window to copy to the texture
x:            X offset in the texture where to copy the source pixels
y:            Y offset in the texture where to copy the source pixels

func (*Texture) UpdateFromWindow ¶

func (this *Texture) UpdateFromWindow(window *Window, x, y uint)

Update a texture from the contents of a window

window:  Window to copy to the texture
x:       X offset in the texture where to copy the source pixels
y:       Y offset in the texture where to copy the source pixels

func (*Transform) Combine ¶

func (this *Transform) Combine(other *Transform) *Transform

Combine two transforms

Mathematically, it is equivalent to a matrix multiplication.

func (*Transform) GetInverse ¶

func (this *Transform) GetInverse() (inverse Transform)

Return the inverse of a transform

If the inverse cannot be computed, a new identity transform is returned.

func (*Transform) GetMatrix ¶

func (this *Transform) GetMatrix() (matrix Matrix)

Return the 4x4 matrix of a transform

This function fills an array of 16 floats with the transform converted as a 4x4 matrix, which is directly compatible with OpenGL functions.

func (*Transform) Rotate ¶

func (this *Transform) Rotate(angle float32) *Transform

Combine the current transform with a rotation

angle: Rotation angle, in degrees

func (*Transform) RotateWithCenter ¶

func (this *Transform) RotateWithCenter(angle, centerX, centerY float32) *Transform

Combine the current transform with a rotation

The center of rotation is provided for convenience as a second argument, so that you can build rotations around arbitrary points more easily (and efficiently) than the usual [translate(-center), rotate(angle), translate(center)].

angle:     Rotation angle, in degrees
centerX:   X coordinate of the center of rotation
centerY:   Y coordinate of the center of rotation

func (*Transform) Scale ¶

func (this *Transform) Scale(scaleX, scaleY float32) *Transform

Combine the current transform with a scaling

scaleX: Scaling factor on the X axis
scaleY: Scaling factor on the Y axis

func (*Transform) ScaleWithCenter ¶

func (this *Transform) ScaleWithCenter(scaleX, scaleY, centerX, centerY float32) *Transform

Combine the current transform with a scaling

The center of scaling is provided for convenience as a second argument, so that you can build scaling around arbitrary points more easily (and efficiently) than the usual [translate(-center), scale(factors), translate(center)]

scaleX:    Scaling factor on X axis
scaleY:    Scaling factor on Y axis
centerX:   X coordinate of the center of scaling
centerY:   Y coordinate of the center of scaling

func (*Transform) TransformPoint ¶

func (this *Transform) TransformPoint(point Vector2f) (tansPoint Vector2f)

Apply a transform to a 2D point

point: Point to transform

func (*Transform) TransformRect ¶

func (this *Transform) TransformRect(rect FloatRect) (tansRect FloatRect)

Apply a transform to a rectangle

Since SFML doesn't provide support for oriented rectangles, the result of this function is always an axis-aligned rectangle. Which means that if the transform contains a rotation, the bounding rectangle of the transformed rectangle is returned.

rect: Rectangle to transform

func (*Transform) Translate ¶

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

Combine a transform with a translation

x: Offset to apply on X axis
y: Offset to apply on Y axis

func (*Transformable) Copy ¶

func (this *Transformable) Copy() *Transformable

Copy an existing transformable

func (*Transformable) GetInverseTransform ¶

func (this *Transformable) GetInverseTransform() (transform Transform)

Get the inverse of the combined transform of a transformable

func (*Transformable) GetOrigin ¶

func (this *Transformable) GetOrigin() (origin Vector2f)

Get the local origin of a transformable

func (*Transformable) GetPosition ¶

func (this *Transformable) GetPosition() (pos Vector2f)

Get the position of a transformable

func (*Transformable) GetRotation ¶

func (this *Transformable) GetRotation() float32

Get the orientation of a transformable

The rotation is always in the range [0, 360].

func (*Transformable) GetScale ¶

func (this *Transformable) GetScale() (scale Vector2f)

Get the current scale of a transformable

func (*Transformable) GetTransform ¶

func (this *Transformable) GetTransform() (trans Transform)

Get the combined transform of a transformable

func (*Transformable) Move ¶

func (this *Transformable) Move(offset Vector2f)

Move a transformable by a given offset

This function adds to the current position of the object, unlike Transformable.SetPosition which overwrites it.

offset: Offset

func (*Transformable) Rotate ¶

func (this *Transformable) Rotate(angle float32)

Rotate a transformable

This function adds to the current rotation of the object, unlike Transformable.SetRotation which overwrites it.

angle: Angle of rotation, in degrees

func (*Transformable) Scale ¶

func (this *Transformable) Scale(factor Vector2f)

Scale a transformable

This function multiplies the current scale of the object, unlike Transformable.SetScale which overwrites it.

factors: Scale factors

func (*Transformable) SetOrigin ¶

func (this *Transformable) SetOrigin(orig Vector2f)

Set the local origin of a transformable

The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable Transformable object is (0, 0).

origin: New origin

func (*Transformable) SetPosition ¶

func (this *Transformable) SetPosition(pos Vector2f)

Set the position of a transformable

This function completely overwrites the previous position. See Transformable.Move to apply an offset based on the previous position instead. The default position of a transformable Transformable object is (0, 0).

position: New position

func (*Transformable) SetRotation ¶

func (this *Transformable) SetRotation(rot float32)

Set the orientation of a transformable

This function completely overwrites the previous rotation. See Transformable.Rotate to add an angle based on the previous rotation instead. The default rotation of a transformable Transformable object is 0.

angle: New rotation, in degrees

func (*Transformable) SetScale ¶

func (this *Transformable) SetScale(scale Vector2f)

Set the scale factors of a transformable

This function completely overwrites the previous scale. See Transformable.Scale to add a factor based on the previous scale instead. The default scale of a transformable Transformable object is (1, 1).

scale: New scale factors

func (Vector2f) Minus ¶

func (this Vector2f) Minus(other Vector2f) Vector2f

Returns the difference of two vectors.

func (Vector2f) Plus ¶

func (this Vector2f) Plus(other Vector2f) Vector2f

Returns the sum of two vectors.

func (Vector2i) Minus ¶

func (this Vector2i) Minus(other Vector2i) Vector2i

Returns the difference of two vectors.

func (Vector2i) Plus ¶

func (this Vector2i) Plus(other Vector2i) Vector2i

Returns the sum of two vectors.

func (Vector2u) Minus ¶

func (this Vector2u) Minus(other Vector2u) Vector2u

Returns the difference of two vectors.

func (Vector2u) Plus ¶

func (this Vector2u) Plus(other Vector2u) Vector2u

Returns the sum of two vectors.

func (*VertexArray) Append ¶

func (this *VertexArray) Append(vertex Vertex)

Add a vertex to a vertex array array

vertex: Vertex to add

Note: You may want to specify the vertex color - otherwise the newly added vertex will be invisible

example: vertexArray.Append(Vertex{Position: Vector2f{}, Color: ColorWhite})

func (*VertexArray) Clear ¶

func (this *VertexArray) Clear()

Clear a vertex array

This function removes all the vertices from the array. It doesn't deallocate the corresponding memory, so that adding new vertices after clearing doesn't involve reallocating all the memory.

func (*VertexArray) Copy ¶

func (this *VertexArray) Copy() *VertexArray

Copy an existing vertex array

func (*VertexArray) Draw ¶

func (this *VertexArray) Draw(target RenderTarget, renderStates RenderStates)

Draws a VertexArray on a render target

Note: Use RenderTarget.DrawPrimitives to draw only a subset of its vertices

func (*VertexArray) GetBounds ¶

func (this *VertexArray) GetBounds() FloatRect

Compute the bounding rectangle of a vertex array

This function returns the axis-aligned rectangle that contains all the vertices of the array

func (*VertexArray) GetVertexCount ¶

func (this *VertexArray) GetVertexCount() int

Return the vertex count of a vertex array

func (*VertexArray) Resize ¶

func (this *VertexArray) Resize(vertexCount int)

Resize the vertex array

If vertexCount is greater than the current size, the previous vertices are kept and new (default-constructed i.e. Vertex.Color is set to white) vertices are added. If vertexCount is less than the current size, existing vertices are removed from the array.

vertexCount: New size of the array (number of vertices)