Documentation of SFML 2.0

sf::Vertex Class Reference

Define a point with color and texture coordinates. More...

#include <Vertex.hpp>

Public Member Functions

 Vertex ()
 Default constructor.
 
 Vertex (const Vector2f &thePosition)
 Construct the vertex from its position.
 
 Vertex (const Vector2f &thePosition, const Color &theColor)
 Construct the vertex from its position and color.
 
 Vertex (const Vector2f &thePosition, const Vector2f &theTexCoords)
 Construct the vertex from its position and texture coordinates.
 
 Vertex (const Vector2f &thePosition, const Color &theColor, const Vector2f &theTexCoords)
 Construct the vertex from its position, color and texture coordinates.
 

Public Attributes

Vector2f position
 2D position of the vertex
 
Color color
 Color of the vertex.
 
Vector2f texCoords
 Coordinates of the texture's pixel to map to the vertex.
 

Detailed Description

Define a point with color and texture coordinates.

A vertex is an improved point.

It has a position and other extra attributes that will be used for drawing: in SFML, vertices also have a color and a pair of texture coordinates.

The vertex is the building block of drawing. Everything which is visible on screen is made of vertices. They are grouped as 2D primitives (triangles, quads, ...), and these primitives are grouped to create even more complex 2D entities such as sprites, texts, etc.

If you use the graphical entities of SFML (sprite, text, shape) you won't have to deal with vertices directly. But if you want to define your own 2D entities, such as tiled maps or particle systems, using vertices will allow you to get maximum performances.

Example:

// define a 100x100 square, red, with a 10x10 texture mapped on it
sf::Vertex vertices[] =
{
};
// draw it
window.draw(vertices, 4, sf::Quads);

Note: although texture coordinates are supposed to be an integer amount of pixels, their type is float because of some buggy graphics drivers that are not able to process integer coordinates correctly.

See Also
sf::VertexArray

Definition at line 42 of file Vertex.hpp.

Constructor & Destructor Documentation

sf::Vertex::Vertex ( )

Default constructor.

sf::Vertex::Vertex ( const Vector2f thePosition)

Construct the vertex from its position.

The vertex color is white and texture coordinates are (0, 0).

Parameters
thePositionVertex position
sf::Vertex::Vertex ( const Vector2f thePosition,
const Color theColor 
)

Construct the vertex from its position and color.

The texture coordinates are (0, 0).

Parameters
thePositionVertex position
theColorVertex color
sf::Vertex::Vertex ( const Vector2f thePosition,
const Vector2f theTexCoords 
)

Construct the vertex from its position and texture coordinates.

The vertex color is white.

Parameters
thePositionVertex position
theTexCoordsVertex texture coordinates
sf::Vertex::Vertex ( const Vector2f thePosition,
const Color theColor,
const Vector2f theTexCoords 
)

Construct the vertex from its position, color and texture coordinates.

Parameters
thePositionVertex position
theColorVertex color
theTexCoordsVertex texture coordinates

Member Data Documentation

Color sf::Vertex::color

Color of the vertex.

Definition at line 98 of file Vertex.hpp.

Vector2f sf::Vertex::position

2D position of the vertex

Definition at line 97 of file Vertex.hpp.

Vector2f sf::Vertex::texCoords

Coordinates of the texture's pixel to map to the vertex.

Definition at line 99 of file Vertex.hpp.


The documentation for this class was generated from the following file: