Struct sfml::graphics::RenderStates

#[repr(C)]
pub struct RenderStates<'texture, 'shader, 'shader_texture: 'shader> {
    pub blend_mode: BlendMode,
    pub transform: Transform,
    /* private fields */
}

Define the states used for drawing to a RenderTarget.

There are four global states that can be applied to the drawn objects:

• the blend mode: how pixels of the object are blended with the background
• the transform: how the object is positioned/rotated/scaled
• the texture: what image is mapped to the object
• the shader: what custom effect is applied to the object

High-level objects such as sprites or text force some of these states when they are drawn. For example, a sprite will set its own texture, so that you don’t have to care about it when drawing the sprite.

The transform is a special case: sprites, texts and shapes (and it’s a good idea to do it with your own drawable classes too) combine their transform with the one that is passed in the RenderStates structure. So that you can use a “global” transform on top of each object’s transform.

Most objects, especially high-level drawables, can be drawn directly without defining render states explicitly – the default set of states is ok in most cases.

window.draw(&sprite);

To draw with a specific render state, use RenderTarget::draw_with_renderstates.

let mut states = RenderStates::default();
states.set_shader(Some(&shader));
window.draw_with_renderstates(&sprite, &states);

When you’re inside the draw function of a drawable object (implementing Drawable), you can either pass the render states unmodified, or change some of them. For example, a transformable object will combine the current transform with its own transform. A sprite will set its texture. Etc.

Fields

blend_mode: BlendMode

The blending mode

transform: Transform

The transform

Implementations

impl<'texture, 'shader, 'shader_texture> RenderStates<'texture, 'shader, 'shader_texture>

pub fn new(
    blend_mode: BlendMode,
    transform: Transform,
    texture: Option<&'texture Texture>,
    shader: Option<&'shader Shader<'shader_texture>>
) -> Self

Create a new RenderStates.

Arguments

• blend_mode - The BlendMode
• transform - The transform
• texture - Some(texture) if there is a texture, None otherwise
• shader - Some(shader) if there is a shader, None otherwise

Return a new default RenderStates

pub fn set_texture(&mut self, texture: Option<&'texture Texture>)

Sets the texture

pub fn set_shader(&mut self, shader: Option<&'shader Shader<'shader_texture>>)

Sets the shader

impl RenderStates<'static, 'static, 'static>

pub const DEFAULT: Self = _

The default render state.

This can be used in a const context, unlike the Default implementation.

Trait Implementations

impl<'texture, 'shader, 'shader_texture: 'shader> Clone for RenderStates<'texture, 'shader, 'shader_texture>

fn clone(&self) -> RenderStates<'texture, 'shader, 'shader_texture>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'texture, 'shader, 'shader_texture: 'shader> Debug for RenderStates<'texture, 'shader, 'shader_texture>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RenderStates<'static, 'static, 'static>

fn default() -> Self

Returns the “default value” for a type.

impl<'texture, 'shader, 'shader_texture: 'shader> Copy for RenderStates<'texture, 'shader, 'shader_texture>