Struct surfman_chains::SwapChain

pub struct SwapChain<Device: DeviceAPI>(_);

A thread-safe swap chain.

Implementations

impl<Device: DeviceAPI> SwapChain<Device>

pub fn swap_buffers(
    &self,
    device: &mut Device,
    context: &mut Device::Context,
    preserve_buffer: PreserveBuffer<'_>
) -> Result<(), Error>

Swap the back and front buffers. Called by the producer. Returns an error if context is not the producer context for this swap chain.

pub fn take_attachment_from(
    &self,
    device: &mut Device,
    context: &mut Device::Context,
    other: &SwapChain<Device>
) -> Result<(), Error>

Swap the attached swap chain. Called by the producer. Returns an error if context is not the producer context for both swap chains. Returns an error if this swap chain is attached, or the other swap chain is detached.

pub fn resize(
    &self,
    device: &mut Device,
    context: &mut Device::Context,
    size: Size2D<i32>
) -> Result<(), Error>

Resize the swap chain. This creates a new back buffer of the appropriate size, and destroys the old one. Called by the producer. Returns an error if context is not the producer context for this swap chain.

pub fn size(&self) -> Size2D<i32>

Get the current size. Called by a consumer.

pub fn take_surface_texture(
    &self,
    device: &Device,
    context: &mut Device::Context
) -> Result<Device::SurfaceTexture, Error>

Take the current back buffer. Called by a producer.

pub fn recycle_surface_texture(
    &self,
    device: &Device,
    context: &mut Device::Context,
    surface_texture: Device::SurfaceTexture
) -> Result<(), Error>

Recycle the current back buffer. Called by a producer.

pub fn take_pending_surface(&self) -> Option<Device::Surface>

Take the current front buffer. Returns None if there is no current front buffer. Called by a consumer.

pub fn clear_surface(
    &self,
    device: &mut Device,
    context: &mut Device::Context,
    gl: &Gl,
    color: [f32; 4]
) -> Result<(), Error>

Clear the current back buffer. Called by the producer. Returns an error if context is not the producer context for this swap chain.

pub fn is_attached(&self) -> bool

Is this the attached swap chain?

pub fn destroy(
    &self,
    device: &mut Device,
    context: &mut Device::Context
) -> Result<(), Error>

Destroy the swap chain. Called by the producer. Returns an error if context is not the producer context for this swap chain.

pub fn create_attached(
    device: &mut Device,
    context: &mut Device::Context,
    surface_access: SurfaceAccess
) -> Result<SwapChain<Device>, Error>

Create a new attached swap chain

pub fn create_detached(
    device: &mut Device,
    context: &mut Device::Context,
    surface_access: SurfaceAccess,
    size: Size2D<i32>
) -> Result<SwapChain<Device>, Error>

Create a new detached swap chain

Trait Implementations

impl<Device: DeviceAPI> Clone for SwapChain<Device>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Device> SwapChainAPI for SwapChain<Device> where
    Device: 'static + DeviceAPI,
    Device::Surface: Send, 

type Surface = Device::Surface

fn take_surface(&self) -> Option<Device::Surface>

Take the current front buffer. Returns the most recent recycled surface if there is no current front buffer. Called by a consumer.

fn recycle_surface(&self, surface: Device::Surface)

Recycle the current front buffer. Called by a consumer.