Struct PictureWrapper

pub struct PictureWrapper<C: RequestConnection>(/* private fields */);

A RAII-like wrapper around a Picture.

Instances of this struct represent a Picture that is freed in Drop.

Any errors during Drop are silently ignored. Most likely an error here means that your X11 connection is broken and later requests will also fail.

Implementations

impl<C: RequestConnection> PictureWrapper<C>

pub fn for_picture(conn: C, id: Picture) -> Self

Assume ownership of the given resource and destroy it in Drop.

pub fn picture(&self) -> Picture

Get the XID of the wrapped resource

pub fn into_picture(self) -> Picture

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

impl<'c, C: X11Connection> PictureWrapper<&'c C>

pub fn create_picture_and_get_cookie( conn: &'c C, drawable: Drawable, format: Pictformat, value_list: &CreatePictureAux, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Picture and return a Picture wrapper and a cookie.

This is a thin wrapper around create_picture that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop. This also returns a VoidCookie that comes from the call to create_picture.

Errors can come from the call to X11Connection::generate_id or create_picture.

impl<C: X11Connection> PictureWrapper<C>

pub fn create_picture( conn: C, drawable: Drawable, format: Pictformat, value_list: &CreatePictureAux, ) -> Result<Self, ReplyOrIdError>

Create a new Picture and return a Picture wrapper

This is a thin wrapper around create_picture that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_picture.

impl<'c, C: X11Connection> PictureWrapper<&'c C>

pub fn create_solid_fill_and_get_cookie( conn: &'c C, color: Color, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Picture and return a Picture wrapper and a cookie.

This is a thin wrapper around create_solid_fill that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop. This also returns a VoidCookie that comes from the call to create_solid_fill.

Errors can come from the call to X11Connection::generate_id or create_solid_fill.

impl<C: X11Connection> PictureWrapper<C>

pub fn create_solid_fill(conn: C, color: Color) -> Result<Self, ReplyOrIdError>

Create a new Picture and return a Picture wrapper

This is a thin wrapper around create_solid_fill that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_solid_fill.

impl<'c, C: X11Connection> PictureWrapper<&'c C>

pub fn create_linear_gradient_and_get_cookie( conn: &'c C, p1: Pointfix, p2: Pointfix, stops: &[Fixed], colors: &[Color], ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Picture and return a Picture wrapper and a cookie.

This is a thin wrapper around create_linear_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop. This also returns a VoidCookie that comes from the call to create_linear_gradient.

Errors can come from the call to X11Connection::generate_id or create_linear_gradient.

impl<C: X11Connection> PictureWrapper<C>

pub fn create_linear_gradient( conn: C, p1: Pointfix, p2: Pointfix, stops: &[Fixed], colors: &[Color], ) -> Result<Self, ReplyOrIdError>

Create a new Picture and return a Picture wrapper

This is a thin wrapper around create_linear_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_linear_gradient.

impl<'c, C: X11Connection> PictureWrapper<&'c C>

pub fn create_radial_gradient_and_get_cookie( conn: &'c C, inner: Pointfix, outer: Pointfix, inner_radius: Fixed, outer_radius: Fixed, stops: &[Fixed], colors: &[Color], ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Picture and return a Picture wrapper and a cookie.

This is a thin wrapper around create_radial_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop. This also returns a VoidCookie that comes from the call to create_radial_gradient.

Errors can come from the call to X11Connection::generate_id or create_radial_gradient.

impl<C: X11Connection> PictureWrapper<C>

pub fn create_radial_gradient( conn: C, inner: Pointfix, outer: Pointfix, inner_radius: Fixed, outer_radius: Fixed, stops: &[Fixed], colors: &[Color], ) -> Result<Self, ReplyOrIdError>

Create a new Picture and return a Picture wrapper

This is a thin wrapper around create_radial_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_radial_gradient.

impl<'c, C: X11Connection> PictureWrapper<&'c C>

pub fn create_conical_gradient_and_get_cookie( conn: &'c C, center: Pointfix, angle: Fixed, stops: &[Fixed], colors: &[Color], ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Picture and return a Picture wrapper and a cookie.

This is a thin wrapper around create_conical_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop. This also returns a VoidCookie that comes from the call to create_conical_gradient.

Errors can come from the call to X11Connection::generate_id or create_conical_gradient.

impl<C: X11Connection> PictureWrapper<C>

pub fn create_conical_gradient( conn: C, center: Pointfix, angle: Fixed, stops: &[Fixed], colors: &[Color], ) -> Result<Self, ReplyOrIdError>

Create a new Picture and return a Picture wrapper

This is a thin wrapper around create_conical_gradient that allocates an id for the Picture. This function returns the resulting PictureWrapper that owns the created Picture and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_conical_gradient.

Trait Implementations

impl<C: Debug + RequestConnection> Debug for PictureWrapper<C>

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

Formats the value using the given formatter.

impl<C: RequestConnection> Drop for PictureWrapper<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&PictureWrapper<C>> for Picture

fn from(from: &PictureWrapper<C>) -> Self

Converts to this type from the input type.