Struct DrawingContext 

pub struct DrawingContext { /* private fields */ }

DrawingContext is an object that represents the current drawing state of a Window.

It’s possible to use a DrawingContext to draw on a Window via rendering API like Cairo or OpenGL.

A DrawingContext can only be created by calling Window::begin_draw_frame() and will be valid until a call to Window::end_draw_frame().

DrawingContext is available since GDK 3.22

Properties

clip

The clip region applied to the drawing context.

Readable | Writeable | Construct Only

window

The Window that created the drawing context.

Readable | Writeable | Construct Only

Implementations

impl DrawingContext

pub fn cairo_context(&self) -> Option<Context>

Retrieves a Cairo context to be used to draw on the Window that created the DrawingContext.

The returned context is guaranteed to be valid as long as the DrawingContext is valid, that is between a call to Window::begin_draw_frame() and Window::end_draw_frame().

Returns

a Cairo context to be used to draw the contents of the Window. The context is owned by the DrawingContext and should not be destroyed

pub fn clip(&self) -> Option<Region>

Retrieves a copy of the clip region used when creating the self.

Returns

a Cairo region

pub fn window(&self) -> Option<Window>

Retrieves the window that created the drawing self.

Returns

a Window

pub fn is_valid(&self) -> bool

Checks whether the given DrawingContext is valid.

Returns

true if the context is valid

Trait Implementations

impl Clone for DrawingContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DrawingContext

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

Formats the value using the given formatter.

impl Display for DrawingContext

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

Formats the value using the given formatter.

impl Eq for DrawingContext

impl HasParamSpec for DrawingContext

type ParamSpec = ParamSpecObject

type SetValue = DrawingContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, DrawingContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DrawingContext

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DrawingContext

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for DrawingContext

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DrawingContext

fn eq(&self, other: &OT) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<OT: ObjectType> PartialOrd<OT> for DrawingContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DrawingContext

fn static_type() -> Type

Returns the type identifier of Self.