Module sdl2::render [] [src]

2D accelerated rendering

Official C documentation: https://wiki.libsdl.org/CategoryRender

Introduction

This module contains functions for 2D accelerated rendering.

This API supports the following features:

  • single pixel points
  • single pixel lines
  • filled rectangles
  • texture images
  • All of these may be drawn in opaque, blended, or additive modes.

The texture images can have an additional color tint or alpha modulation applied to them, and may also be stretched with linear interpolation, rotated or flipped/mirrored.

For advanced functionality like particle effects or actual 3D you should use SDL's OpenGL/Direct3D support or one of the many available 3D engines.

This API is not designed to be used from multiple threads, see this bug for details.


None of the draw methods in Renderer are expected to fail. If they do, a panic is raised and the program is aborted.

Structs

DriverIterator
RenderTarget

A handle for getting/setting the render target of the render context.

Renderer

2D rendering context

RendererBuilder

The type that allows you to build Window-based renderers.

RendererInfo

A structure that contains information on the capabilities of a render driver or the current render context.

Texture

A texture for a rendering context.

TextureQuery

Enums

BlendMode
RendererParent
TextureAccess
TextureValueError
UpdateTextureError
UpdateTextureYUVError

Functions

drivers

Gets an iterator of all render drivers compiled into the SDL2 library.