Struct gbm::SurfaceBufferHandle

pub struct SurfaceBufferHandle<T: 'static>(_, _);

Handle to a front buffer of a surface

Methods from Deref<Target = BufferObject<T>>

pub fn width(&self) -> Result<u32, DeviceDestroyedError>

Get the width of the buffer object

pub fn height(&self) -> Result<u32, DeviceDestroyedError>

Get the height of the buffer object

pub fn stride(&self) -> Result<u32, DeviceDestroyedError>

Get the stride of the buffer object

pub fn format(&self) -> Result<Format, DeviceDestroyedError>

Get the format of the buffer object

pub fn handle(&self) -> Result<BufferObjectHandle, DeviceDestroyedError>

Get the handle of the buffer object

This is stored in the platform generic union BufferObjectHandle type. However the format of this handle is platform specific.

pub fn map<'a, D, F, S>(
    &'a self,
    device: &Device<D>,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    f: F
) -> Result<IoResult<S>, WrongDeviceError>where
    D: AsRawFd + 'static,
    F: FnOnce(&MappedBufferObject<'a, T>) -> S,

Map a region of a gbm buffer object for cpu access

This function maps a region of a gbm bo for cpu read access.

pub fn map_mut<'a, D, F, S>(
    &'a mut self,
    device: &Device<D>,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    f: F
) -> Result<IoResult<S>, WrongDeviceError>where
    D: AsRawFd + 'static,
    F: FnOnce(&mut MappedBufferObject<'a, T>) -> S,

Map a region of a gbm buffer object for cpu access

This function maps a region of a gbm bo for cpu read/write access.

pub fn write(
    &mut self,
    buffer: &[u8]
) -> Result<IoResult<()>, DeviceDestroyedError>

Write data into the buffer object

If the buffer object was created with the BufferObjectFlags::Write flag, this function can be used to write data into the buffer object. The data is copied directly into the object and it’s the responsibility of the caller to make sure the data represents valid pixel data, according to the width, height, stride and format of the buffer object.

pub fn set_userdata(
    &mut self,
    userdata: T
) -> Result<Option<T>, DeviceDestroyedError>

Sets the userdata of the buffer object.

If previously userdata was set, it is returned.

pub fn clear_userdata(&mut self) -> Result<(), DeviceDestroyedError>

Clears the set userdata of the buffer object.

pub fn userdata(&self) -> Result<Option<&T>, DeviceDestroyedError>

Returns a reference to set userdata, if any.

pub fn userdata_mut(&mut self) -> Result<Option<&mut T>, DeviceDestroyedError>

Returns a mutable reference to set userdata, if any.

pub fn take_userdata(&mut self) -> Result<Option<T>, DeviceDestroyedError>

Takes ownership of previously set userdata, if any.

This removes the userdata from the buffer object.

Trait Implementations

impl<T: 'static> Deref for SurfaceBufferHandle<T>

type Target = BufferObject<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: 'static> DerefMut for SurfaceBufferHandle<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: 'static> Drop for SurfaceBufferHandle<T>

fn drop(&mut self)

Executes the destructor for this type.