Loading...
Searching...
No Matches
RectangleShape.h File Reference
#include <SFML/Graphics/Export.h>
#include <SFML/Graphics/Color.h>
#include <SFML/Graphics/Rect.h>
#include <SFML/Graphics/Transform.h>
#include <SFML/Graphics/Types.h>
#include <SFML/System/Vector2.h>
#include <stddef.h>

Go to the source code of this file.

Functions

sfRectangleShapesfRectangleShape_create (void)
 Create a new rectangle shape.
 
sfRectangleShapesfRectangleShape_copy (const sfRectangleShape *shape)
 Copy an existing rectangle shape.
 
void sfRectangleShape_destroy (sfRectangleShape *shape)
 Destroy an existing rectangle shape.
 
void sfRectangleShape_setPosition (sfRectangleShape *shape, sfVector2f position)
 Set the position of a rectangle shape.
 
void sfRectangleShape_setRotation (sfRectangleShape *shape, float angle)
 Set the orientation of a rectangle shape.
 
void sfRectangleShape_setScale (sfRectangleShape *shape, sfVector2f scale)
 Set the scale factors of a rectangle shape.
 
void sfRectangleShape_setOrigin (sfRectangleShape *shape, sfVector2f origin)
 Set the local origin of a rectangle shape.
 
sfVector2f sfRectangleShape_getPosition (const sfRectangleShape *shape)
 Get the position of a rectangle shape.
 
float sfRectangleShape_getRotation (const sfRectangleShape *shape)
 Get the orientation of a rectangle shape.
 
sfVector2f sfRectangleShape_getScale (const sfRectangleShape *shape)
 Get the current scale of a rectangle shape.
 
sfVector2f sfRectangleShape_getOrigin (const sfRectangleShape *shape)
 Get the local origin of a rectangle shape.
 
void sfRectangleShape_move (sfRectangleShape *shape, sfVector2f offset)
 Move a rectangle shape by a given offset.
 
void sfRectangleShape_rotate (sfRectangleShape *shape, float angle)
 Rotate a rectangle shape.
 
void sfRectangleShape_scale (sfRectangleShape *shape, sfVector2f factors)
 Scale a rectangle shape.
 
sfTransform sfRectangleShape_getTransform (const sfRectangleShape *shape)
 Get the combined transform of a rectangle shape.
 
sfTransform sfRectangleShape_getInverseTransform (const sfRectangleShape *shape)
 Get the inverse of the combined transform of a rectangle shape.
 
void sfRectangleShape_setTexture (sfRectangleShape *shape, const sfTexture *texture, sfBool resetRect)
 Change the source texture of a rectangle shape.
 
void sfRectangleShape_setTextureRect (sfRectangleShape *shape, sfIntRect rect)
 Set the sub-rectangle of the texture that a rectangle shape will display.
 
void sfRectangleShape_setFillColor (sfRectangleShape *shape, sfColor color)
 Set the fill color of a rectangle shape.
 
void sfRectangleShape_setOutlineColor (sfRectangleShape *shape, sfColor color)
 Set the outline color of a rectangle shape.
 
void sfRectangleShape_setOutlineThickness (sfRectangleShape *shape, float thickness)
 Set the thickness of a rectangle shape's outline.
 
const sfTexturesfRectangleShape_getTexture (const sfRectangleShape *shape)
 Get the source texture of a rectangle shape.
 
sfIntRect sfRectangleShape_getTextureRect (const sfRectangleShape *shape)
 Get the sub-rectangle of the texture displayed by a rectangle shape.
 
sfColor sfRectangleShape_getFillColor (const sfRectangleShape *shape)
 Get the fill color of a rectangle shape.
 
sfColor sfRectangleShape_getOutlineColor (const sfRectangleShape *shape)
 Get the outline color of a rectangle shape.
 
float sfRectangleShape_getOutlineThickness (const sfRectangleShape *shape)
 Get the outline thickness of a rectangle shape.
 
size_t sfRectangleShape_getPointCount (const sfRectangleShape *shape)
 Get the total number of points of a rectangle shape.
 
sfVector2f sfRectangleShape_getPoint (const sfRectangleShape *shape, size_t index)
 Get a point of a rectangle shape.
 
void sfRectangleShape_setSize (sfRectangleShape *shape, sfVector2f size)
 Set the size of a rectangle shape.
 
sfVector2f sfRectangleShape_getSize (const sfRectangleShape *shape)
 Get the size of a rectangle shape.
 
sfFloatRect sfRectangleShape_getLocalBounds (const sfRectangleShape *shape)
 Get the local bounding rectangle of a rectangle shape.
 
sfFloatRect sfRectangleShape_getGlobalBounds (const sfRectangleShape *shape)
 Get the global bounding rectangle of a rectangle shape.
 

Function Documentation

◆ sfRectangleShape_copy()

sfRectangleShape * sfRectangleShape_copy ( const sfRectangleShape shape)

Copy an existing rectangle shape.

Parameters
shapeShape to copy
Returns
Copied object

◆ sfRectangleShape_create()

sfRectangleShape * sfRectangleShape_create ( void  )

Create a new rectangle shape.

Returns
A new sfRectangleShape object, or NULL if it failed

◆ sfRectangleShape_destroy()

void sfRectangleShape_destroy ( sfRectangleShape shape)

Destroy an existing rectangle shape.

Parameters
shapeShape to delete

◆ sfRectangleShape_getFillColor()

sfColor sfRectangleShape_getFillColor ( const sfRectangleShape shape)

Get the fill color of a rectangle shape.

Parameters
shapeShape object
Returns
Fill color of the shape

◆ sfRectangleShape_getGlobalBounds()

sfFloatRect sfRectangleShape_getGlobalBounds ( const sfRectangleShape shape)

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.

Parameters
shapeShape object
Returns
Global bounding rectangle of the entity

◆ sfRectangleShape_getInverseTransform()

sfTransform sfRectangleShape_getInverseTransform ( const sfRectangleShape shape)

Get the inverse of the combined transform of a rectangle shape.

Parameters
shapeshape object
Returns
Inverse of the combined transformations applied to the object

◆ sfRectangleShape_getLocalBounds()

sfFloatRect sfRectangleShape_getLocalBounds ( const sfRectangleShape shape)

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.

Parameters
shapeShape object
Returns
Local bounding rectangle of the entity

◆ sfRectangleShape_getOrigin()

sfVector2f sfRectangleShape_getOrigin ( const sfRectangleShape shape)

Get the local origin of a rectangle shape.

Parameters
shapeShape object
Returns
Current origin

◆ sfRectangleShape_getOutlineColor()

sfColor sfRectangleShape_getOutlineColor ( const sfRectangleShape shape)

Get the outline color of a rectangle shape.

Parameters
shapeShape object
Returns
Outline color of the shape

◆ sfRectangleShape_getOutlineThickness()

float sfRectangleShape_getOutlineThickness ( const sfRectangleShape shape)

Get the outline thickness of a rectangle shape.

Parameters
shapeShape object
Returns
Outline thickness of the shape

◆ sfRectangleShape_getPoint()

sfVector2f sfRectangleShape_getPoint ( const sfRectangleShape shape,
size_t  index 
)

Get a point of a rectangle shape.

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

Parameters
shapeShape object
indexIndex of the point to get, in range [0 .. getPointCount() - 1]
Returns
Index-th point of the shape

◆ sfRectangleShape_getPointCount()

size_t sfRectangleShape_getPointCount ( const sfRectangleShape shape)

Get the total number of points of a rectangle shape.

Parameters
shapeShape object
Returns
Number of points of the shape

◆ sfRectangleShape_getPosition()

sfVector2f sfRectangleShape_getPosition ( const sfRectangleShape shape)

Get the position of a rectangle shape.

Parameters
shapeShape object
Returns
Current position

◆ sfRectangleShape_getRotation()

float sfRectangleShape_getRotation ( const sfRectangleShape shape)

Get the orientation of a rectangle shape.

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

Parameters
shapeShape object
Returns
Current rotation, in degrees

◆ sfRectangleShape_getScale()

sfVector2f sfRectangleShape_getScale ( const sfRectangleShape shape)

Get the current scale of a rectangle shape.

Parameters
shapeShape object
Returns
Current scale factors

◆ sfRectangleShape_getSize()

sfVector2f sfRectangleShape_getSize ( const sfRectangleShape shape)

Get the size of a rectangle shape.

Parameters
shapeShape object
Returns
height Size of the rectangle

◆ sfRectangleShape_getTexture()

const sfTexture * sfRectangleShape_getTexture ( const sfRectangleShape shape)

Get the source texture of a rectangle shape.

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

Parameters
shapeShape object
Returns
Pointer to the shape's texture

◆ sfRectangleShape_getTextureRect()

sfIntRect sfRectangleShape_getTextureRect ( const sfRectangleShape shape)

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

Parameters
shapeShape object
Returns
Texture rectangle of the shape

◆ sfRectangleShape_getTransform()

sfTransform sfRectangleShape_getTransform ( const sfRectangleShape shape)

Get the combined transform of a rectangle shape.

Parameters
shapeshape object
Returns
Transform combining the position/rotation/scale/origin of the object

◆ sfRectangleShape_move()

void sfRectangleShape_move ( sfRectangleShape shape,
sfVector2f  offset 
)

Move a rectangle shape by a given offset.

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

Parameters
shapeShape object
offsetOffset

◆ sfRectangleShape_rotate()

void sfRectangleShape_rotate ( sfRectangleShape shape,
float  angle 
)

Rotate a rectangle shape.

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

Parameters
shapeShape object
angleAngle of rotation, in degrees

◆ sfRectangleShape_scale()

void sfRectangleShape_scale ( sfRectangleShape shape,
sfVector2f  factors 
)

Scale a rectangle shape.

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

Parameters
shapeShape object
factorsScale factors

◆ sfRectangleShape_setFillColor()

void sfRectangleShape_setFillColor ( sfRectangleShape shape,
sfColor  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.

Parameters
shapeShape object
colorNew color of the shape

◆ sfRectangleShape_setOrigin()

void sfRectangleShape_setOrigin ( sfRectangleShape shape,
sfVector2f  origin 
)

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).

Parameters
shapeShape object
originNew origin

◆ sfRectangleShape_setOutlineColor()

void sfRectangleShape_setOutlineColor ( sfRectangleShape shape,
sfColor  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.

Parameters
shapeShape object
colorNew outline color of the shape

◆ sfRectangleShape_setOutlineThickness()

void sfRectangleShape_setOutlineThickness ( sfRectangleShape shape,
float  thickness 
)

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.

Parameters
shapeShape object
thicknessNew outline thickness

◆ sfRectangleShape_setPosition()

void sfRectangleShape_setPosition ( sfRectangleShape shape,
sfVector2f  position 
)

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).

Parameters
shapeShape object
positionNew position

◆ sfRectangleShape_setRotation()

void sfRectangleShape_setRotation ( sfRectangleShape shape,
float  angle 
)

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.

Parameters
shapeShape object
angleNew rotation, in degrees

◆ sfRectangleShape_setScale()

void sfRectangleShape_setScale ( sfRectangleShape shape,
sfVector2f  scale 
)

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).

Parameters
shapeShape object
scaleNew scale factors

◆ sfRectangleShape_setSize()

void sfRectangleShape_setSize ( sfRectangleShape shape,
sfVector2f  size 
)

Set the size of a rectangle shape.

Parameters
shapeShape object
sizeNew size of the rectangle

◆ sfRectangleShape_setTexture()

void sfRectangleShape_setTexture ( sfRectangleShape shape,
const sfTexture texture,
sfBool  resetRect 
)

Change the source texture of a rectangle shape.

The texture argument refers to a texture that must exist as long as the shape uses it. Indeed, the shape 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 shape tries to use it, the behaviour is undefined. texture can be NULL 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.

Parameters
shapeShape object
textureNew texture
resetRectShould the texture rect be reset to the size of the new texture?

◆ sfRectangleShape_setTextureRect()

void sfRectangleShape_setTextureRect ( sfRectangleShape shape,
sfIntRect  rect 
)

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.

Parameters
shapeShape object
rectRectangle defining the region of the texture to display