Struct sfml::graphics::RenderTexture

pub struct RenderTexture { /* private fields */ }

Target for off-screen 2D rendering into a texture

Implementations

impl RenderTexture

pub fn new(width: u32, height: u32) -> Option<RenderTexture>

Construct a new render texture

Arguments

• width - Width of the render texture
• height - Height of the render texture

Returns None if creation fails.

pub fn with_settings(
    width: u32,
    height: u32,
    settings: &ContextSettings
) -> Option<Self>

Create a RenderTexture with the given ContextSettings.

Useful if you want to enable multi-sampling or use the render-texture for OpenGL rendering that requires a depth or stencil buffer. Otherwise it is unnecessary, and you should call RenderTexture::new.

Parameters

• width - Width of the render-texture
• height - Height of the render-texture
• settings - Additional settings for the underlying OpenGL texture and context

Returns None if creation fails.

pub fn display(&self)

Update the contents of the target texture

pub fn set_active(&mut self, active: bool) -> bool

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

Arguments

• active - true to activate, false to deactivate

pub fn texture(&self) -> &Texture

Get the target texture of a render texture

Return the target texture

pub fn set_smooth(&mut self, smooth: bool)

Enable or disable the smooth filter on a render texture

Arguments

• smooth - true to enable smoothing, false to disable it

pub fn is_smooth(&self) -> bool

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

Return true if smoothing is enabled, false if it is disabled

pub fn set_repeated(&mut self, repeated: bool)

Enable or disable texture repeating.

This function is similar to Texture::setRepeated. This parameter is disabled by default.

pub fn is_repeated(&self) -> bool

Tell whether the texture is repeated or not.

pub unsafe fn generate_mipmap(&mut self) -> bool

Generate a mipmap using the current texture data.

This function is similar to Texture::generate_mipmap and operates on the texture used as the target for drawing.

Safety

Be aware that any draw operation may modify the base level image data. For this reason, calling this function only makes sense after all drawing is completed and display has been called. Not calling display after subsequent drawing will lead to undefined behavior if a mipmap had been previously generated.

pub fn maximum_antialiasing_level() -> u32

Get the maximum anti-aliasing level supported by the system.

Trait Implementations

impl Debug for RenderTexture

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

Formats the value using the given formatter.

impl Drop for RenderTexture

fn drop(&mut self)

Executes the destructor for this type.

impl RenderTarget for RenderTexture

fn size(&self) -> Vector2u

Get the size of the rendering region of a window

fn clear(&mut self, color: Color)

clear the screen

fn set_view(&mut self, view: &View)

set a new view to the target

fn view(&self) -> &View

return the current view

fn default_view(&self) -> &View

get the default view for the render target

fn viewport(&self, view: &View) -> IntRect

get the viewport of the render target

fn map_pixel_to_coords(&self, point: Vector2i, view: &View) -> Vector2f

Convert a point from window coordinates to world coordinates

fn map_pixel_to_coords_current_view(&self, point: Vector2i) -> Vector2f

Convert a point from window coordinates to world coordinates

fn map_coords_to_pixel(&self, point: Vector2f, view: &View) -> Vector2i

Convert a point from world coordinates to window coordinates

fn map_coords_to_pixel_current_view(&self, point: Vector2f) -> Vector2i

Convert a point from window coordinates to world coordinates

fn draw(&mut self, object: &dyn Drawable)

Draw a drawable object to the render target

fn draw_with_renderstates(
    &mut self,
    object: &dyn Drawable,
    render_states: &RenderStates<'_, '_, '_>
)

Draw a drawable object to the render-target with a RenderStates

fn draw_text(&self, text: &Text<'_>, rs: &RenderStates<'_, '_, '_>)

Draw Text

fn draw_shape(&self, shape: &CustomShape<'_>, rs: &RenderStates<'_, '_, '_>)

Draw Shape

fn draw_sprite(&self, sprite: &Sprite<'_>, rs: &RenderStates<'_, '_, '_>)

Draw Sprite

fn draw_circle_shape(
    &self,
    circle_shape: &CircleShape<'_>,
    rs: &RenderStates<'_, '_, '_>
)

Draw CircleShape

fn draw_rectangle_shape(
    &self,
    rectangle_shape: &RectangleShape<'_>,
    rs: &RenderStates<'_, '_, '_>
)

Draw RectangleShape

fn draw_convex_shape(
    &self,
    convex_shape: &ConvexShape<'_>,
    rs: &RenderStates<'_, '_, '_>
)

Draw ConvexShape

fn draw_vertex_buffer(
    &self,
    vertex_buffer: &VertexBuffer,
    rs: &RenderStates<'_, '_, '_>
)

Draw VertexBuffer

fn draw_primitives(
    &self,
    vertices: &[Vertex],
    ty: PrimitiveType,
    rs: &RenderStates<'_, '_, '_>
)

draw primitives

fn push_gl_states(&mut self)

Save the current OpenGL render states and matrices

fn pop_gl_states(&mut self)

Restore the previously saved OpenGL render states and matrices

fn reset_gl_states(&mut self)

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