Struct swsurface::Config

pub struct Config {
    pub vsync: bool,
    pub image_count: usize,
    pub align: usize,
    pub scanline_align: usize,
    pub opaque: bool,
}

Configuration for a Surface.

Fields

vsync: bool

Enable vertical sync.

This flag is merely a hint and may be ignored.

image_count: usize

The preferred number of swapchain images. Must be >= 1.

This value is merely a hint and may be ignored.

align: usize

The preferred memory alignment of swapchain images.

• This value must not be zero.
• This value must be a power of two.
• This value is merely a hint and may be ignored.

scanline_align: usize

The preferred memory alignment of scanlines in swapchain images.

• This value must not be zero.
• This value must be a power of two.
• This value must be equal to or less than align.
• This value is merely a hint and may be ignored.

opaque: bool

Specifies whether the surface is opaque or not.

If false is specified, the content of the surface is blended over the content below the window. The alpha values are interpreted as pre-multiplied alpha. You also have to specify an appropriate window creation option such as WindowBuilder::with_transparent(true) and use a pixel format having an alpha channel for this option to work.

Defaults to true.

Methods

impl Config

pub fn new() -> Self

Construct a default Config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Config

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.