CSFML

- Main Page
- Data Structures
- Files

- File List
- Globals

Typedefs | Functions
Shape.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>`

Go to the source code of this file.

## Typedefs

typedef unsigned int(* | sfShapeGetPointCountCallback )(void *)
| Type of the callback used to get the number of points in a shape. More...
typedef sfVector2f(* | sfShapeGetPointCallback )(unsigned int, void *)
| Type of the callback used to get a point of a shape. More...

## Functions

CSFML_GRAPHICS_API sfShape * | sfShape_create (sfShapeGetPointCountCallback getPointCount, sfShapeGetPointCallback getPoint, void *userData)
| Create a new shape. More...
CSFML_GRAPHICS_API void | sfShape_destroy (sfShape *shape)
| Destroy an existing shape. More...
CSFML_GRAPHICS_API void | sfShape_setPosition (sfShape *shape, sfVector2f position)
| Set the position of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setRotation (sfShape *shape, float angle)
| Set the orientation of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setScale (sfShape *shape, sfVector2f scale)
| Set the scale factors of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setOrigin (sfShape *shape, sfVector2f origin)
| Set the local origin of a shape. More...
CSFML_GRAPHICS_API sfVector2f | sfShape_getPosition (const sfShape *shape)
| Get the position of a shape. More...
CSFML_GRAPHICS_API float | sfShape_getRotation (const sfShape *shape)
| Get the orientation of a shape. More...
CSFML_GRAPHICS_API sfVector2f | sfShape_getScale (const sfShape *shape)
| Get the current scale of a shape. More...
CSFML_GRAPHICS_API sfVector2f | sfShape_getOrigin (const sfShape *shape)
| Get the local origin of a shape. More...
CSFML_GRAPHICS_API void | sfShape_move (sfShape *shape, sfVector2f offset)
| Move a shape by a given offset. More...
CSFML_GRAPHICS_API void | sfShape_rotate (sfShape *shape, float angle)
| Rotate a shape. More...
CSFML_GRAPHICS_API void | sfShape_scale (sfShape *shape, sfVector2f factors)
| Scale a shape. More...
CSFML_GRAPHICS_API sfTransform | sfShape_getTransform (const sfShape *shape)
| Get the combined transform of a shape. More...
CSFML_GRAPHICS_API sfTransform | sfShape_getInverseTransform (const sfShape *shape)
| Get the inverse of the combined transform of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setTexture (sfShape *shape, const sfTexture *texture, sfBool resetRect)
| Change the source texture of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setTextureRect (sfShape *shape, sfIntRect rect)
| Set the sub-rectangle of the texture that a shape will display. More...
CSFML_GRAPHICS_API void | sfShape_setFillColor (sfShape *shape, sfColor color)
| Set the fill color of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setOutlineColor (sfShape *shape, sfColor color)
| Set the outline color of a shape. More...
CSFML_GRAPHICS_API void | sfShape_setOutlineThickness (sfShape *shape, float thickness)
| Set the thickness of a shape's outline. More...
CSFML_GRAPHICS_API const sfTexture * | sfShape_getTexture (const sfShape *shape)
| Get the source texture of a shape. More...
CSFML_GRAPHICS_API sfIntRect | sfShape_getTextureRect (const sfShape *shape)
| Get the sub-rectangle of the texture displayed by a shape. More...
CSFML_GRAPHICS_API sfColor | sfShape_getFillColor (const sfShape *shape)
| Get the fill color of a shape. More...
CSFML_GRAPHICS_API sfColor | sfShape_getOutlineColor (const sfShape *shape)
| Get the outline color of a shape. More...
CSFML_GRAPHICS_API float | sfShape_getOutlineThickness (const sfShape *shape)
| Get the outline thickness of a shape. More...
CSFML_GRAPHICS_API unsigned int | sfShape_getPointCount (const sfShape *shape)
| Get the total number of points of a shape. More...
CSFML_GRAPHICS_API sfVector2f | sfShape_getPoint (const sfShape *shape, unsigned int index)
| Get a point of a shape. More...
CSFML_GRAPHICS_API sfFloatRect | sfShape_getLocalBounds (const sfShape *shape)
| Get the local bounding rectangle of a shape. More...
CSFML_GRAPHICS_API sfFloatRect | sfShape_getGlobalBounds (const sfShape *shape)
| Get the global bounding rectangle of a shape. More...
CSFML_GRAPHICS_API void | sfShape_update (sfShape *shape)
| Recompute the internal geometry of a shape. More...

## Typedef Documentation

typedef sfVector2f(* sfShapeGetPointCallback)(unsigned int, void *)

Type of the callback used to get a point of a shape.

Definition at line 40 of file Shape.h.

typedef unsigned int(* sfShapeGetPointCountCallback)(void *)

Type of the callback used to get the number of points in a shape.

Definition at line 39 of file Shape.h.

## Function Documentation

CSFML_GRAPHICS_API sfShape* sfShape_create | ( | sfShapeGetPointCountCallback | getPointCount,
|  | sfShapeGetPointCallback | getPoint,
|  | void * | userData
| ) |  |

Create a new shape.

Parameters

  getPointCount | Callback that provides the point count of the shape
  getPoint | Callback that provides the points of the shape
  userData | Data to pass to the callback functions

Returns
  A new sfShape object

CSFML_GRAPHICS_API void sfShape_destroy | ( | sfShape * | shape | ) |

Destroy an existing shape.

Parameters

  Shape | Shape to delete

CSFML_GRAPHICS_API sfColor sfShape_getFillColor | ( | const sfShape * | shape | ) |

Get the fill color of a shape.

Parameters

  shape | Shape object

Returns
  Fill color of the shape

CSFML_GRAPHICS_API sfFloatRect sfShape_getGlobalBounds | ( | const sfShape * | shape | ) |

Get the global bounding rectangle of a 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

  shape | Shape object

Returns
  Global bounding rectangle of the entity

CSFML_GRAPHICS_API sfTransform sfShape_getInverseTransform | ( | const sfShape * | shape | ) |

Get the inverse of the combined transform of a shape.

Parameters

  shape | shape object

Returns
  Inverse of the combined transformations applied to the object

CSFML_GRAPHICS_API sfFloatRect sfShape_getLocalBounds | ( | const sfShape * | shape | ) |

Get the local bounding rectangle of a 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

  shape | Shape object

Returns
  Local bounding rectangle of the entity

CSFML_GRAPHICS_API sfVector2f sfShape_getOrigin | ( | const sfShape * | shape | ) |

Get the local origin of a shape.

Parameters

  shape | Shape object

Returns
  Current origin

CSFML_GRAPHICS_API sfColor sfShape_getOutlineColor | ( | const sfShape * | shape | ) |

Get the outline color of a shape.

Parameters

  shape | Shape object

Returns
  Outline color of the shape

CSFML_GRAPHICS_API float sfShape_getOutlineThickness | ( | const sfShape * | shape | ) |

Get the outline thickness of a shape.

Parameters

  shape | Shape object

Returns
  Outline thickness of the shape

CSFML_GRAPHICS_API sfVector2f sfShape_getPoint | ( | const sfShape * | shape,
|  | unsigned int | index
| ) |  |

Get a point of a shape.

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

Parameters

  shape | Shape object
  index | Index of the point to get, in range [0 .. getPointCount() - 1]

Returns
  Index-th point of the shape

CSFML_GRAPHICS_API unsigned int sfShape_getPointCount | ( | const sfShape * | shape | ) |

Get the total number of points of a shape.

Parameters

  shape | Shape object

Returns
  Number of points of the shape

CSFML_GRAPHICS_API sfVector2f sfShape_getPosition | ( | const sfShape * | shape | ) |

Get the position of a shape.

Parameters

  shape | Shape object

Returns
  Current position

CSFML_GRAPHICS_API float sfShape_getRotation | ( | const sfShape * | shape | ) |

Get the orientation of a shape.

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

Parameters

  shape | Shape object

Returns
  Current rotation, in degrees

CSFML_GRAPHICS_API sfVector2f sfShape_getScale | ( | const sfShape * | shape | ) |

Get the current scale of a shape.

Parameters

  shape | Shape object

Returns
  Current scale factors

CSFML_GRAPHICS_API const sfTexture* sfShape_getTexture | ( | const sfShape * | shape | ) |

Get the source texture of a 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

  shape | Shape object

Returns
  Pointer to the shape's texture

CSFML_GRAPHICS_API sfIntRect sfShape_getTextureRect | ( | const sfShape * | shape | ) |

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

Parameters

  shape | Shape object

Returns
  Texture rectangle of the shape

CSFML_GRAPHICS_API sfTransform sfShape_getTransform | ( | const sfShape * | shape | ) |

Get the combined transform of a shape.

Parameters

  shape | shape object

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

CSFML_GRAPHICS_API void sfShape_move | ( | sfShape * | shape,
|  | sfVector2f | offset
| ) |  |

Move a shape by a given offset.

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

Parameters

  shape | Shape object
  offset | Offset

CSFML_GRAPHICS_API void sfShape_rotate | ( | sfShape * | shape,
|  | float | angle
| ) |  |

Rotate a shape.

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

Parameters

  shape | Shape object
  angle | Angle of rotation, in degrees

CSFML_GRAPHICS_API void sfShape_scale | ( | sfShape * | shape,
|  | sfVector2f | factors
| ) |  |

Scale a shape.

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

Parameters

  shape | Shape object
  factors | Scale factors

CSFML_GRAPHICS_API void sfShape_setFillColor | ( | sfShape * | shape,
|  | sfColor | color
| ) |  |

Set the fill color of a 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

  shape | Shape object
  color | New color of the shape

CSFML_GRAPHICS_API void sfShape_setOrigin | ( | sfShape * | shape,
|  | sfVector2f | origin
| ) |  |

Set the local origin of a 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

  shape | Shape object
  origin | New origin

CSFML_GRAPHICS_API void sfShape_setOutlineColor | ( | sfShape * | shape,
|  | sfColor | color
| ) |  |

Set the outline color of a shape.

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

Parameters

  shape | Shape object
  color | New outline color of the shape

CSFML_GRAPHICS_API void sfShape_setOutlineThickness | ( | sfShape * | shape,
|  | float | thickness
| ) |  |

Set the thickness of a shape's outline.

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

Parameters

  shape | Shape object
  thickness | New outline thickness

CSFML_GRAPHICS_API void sfShape_setPosition | ( | sfShape * | shape,
|  | sfVector2f | position
| ) |  |

Set the position of a shape.

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

Parameters

  shape | Shape object
  position | New position

CSFML_GRAPHICS_API void sfShape_setRotation | ( | sfShape * | shape,
|  | float | angle
| ) |  |

Set the orientation of a shape.

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

Parameters

  shape | Shape object
  angle | New rotation, in degrees

CSFML_GRAPHICS_API void sfShape_setScale | ( | sfShape * | shape,
|  | sfVector2f | scale
| ) |  |

Set the scale factors of a shape.

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

Parameters

  shape | Shape object
  scale | New scale factors

CSFML_GRAPHICS_API void sfShape_setTexture | ( | sfShape * | shape,
|  | const sfTexture * | texture,
|  | sfBool | resetRect
| ) |  |

Change the source texture of a 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

  shape | Shape object
  texture | New texture
  resetRect | Should the texture rect be reset to the size of the new texture?

CSFML_GRAPHICS_API void sfShape_setTextureRect | ( | sfShape * | shape,
|  | sfIntRect | rect
| ) |  |

Set the sub-rectangle of the texture that a 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

  shape | Shape object
  rect | Rectangle defining the region of the texture to display

CSFML_GRAPHICS_API void sfShape_update | ( | sfShape * | shape | ) |

Recompute the internal geometry of a shape.

This function must be called by specialized shape objects everytime their points change (ie. the result of either the getPointCount or getPoint callbacks is different).