Struct cairo::Surface

#[repr(transparent)]
pub struct Surface(_);

Implementations

impl Surface

pub unsafe fn from_raw_none(ptr: *mut cairo_surface_t) -> Surface

pub unsafe fn from_raw_borrow(ptr: *mut cairo_surface_t) -> Borrowed<Surface>

pub unsafe fn from_raw_full(ptr: *mut cairo_surface_t) -> Result<Surface, Error>

pub fn to_raw_none(&self) -> *mut cairo_surface_t

pub fn create_similar(
    &self,
    content: Content,
    width: i32,
    height: i32
) -> Result<Surface, Error>

pub fn create_for_rectangle(&self, bounds: Rectangle) -> Result<Surface, Error>

pub fn mime_data(&self, mime_type: &str) -> Option<Vec<u8>>

pub unsafe fn mime_data_raw(&self, mime_type: &str) -> Option<&[u8]>

pub fn set_mime_data<T: AsRef<[u8]> + 'static>(
    &self,
    mime_type: &str,
    slice: T
) -> Result<(), Error>

pub fn supports_mime_type(&self, mime_type: &str) -> bool

pub fn device(&self) -> Option<Device>

pub fn content(&self) -> Content

pub fn set_device_offset(&self, x_offset: f64, y_offset: f64)

pub fn device_offset(&self) -> (f64, f64)

pub fn set_device_scale(&self, x_scale: f64, y_scale: f64)

pub fn device_scale(&self) -> (f64, f64)

pub fn set_fallback_resolution(
    &self,
    x_pixels_per_inch: f64,
    y_pixels_per_inch: f64
)

pub fn fallback_resolution(&self) -> (f64, f64)

pub fn create_similar_image(
    &self,
    format: Format,
    width: i32,
    height: i32
) -> Result<Surface, Error>

pub fn map_to_image(
    &self,
    extents: Option<RectangleInt>
) -> Result<MappedImageSurface, Error>

pub fn mark_dirty(&self)

pub fn mark_dirty_rectangle(&self, x: i32, y: i32, width: i32, height: i32)

pub fn status(&self) -> Result<(), Error>

pub fn set_user_data<T: 'static>(
    &self,
    key: &'static UserDataKey<T>,
    value: Rc<T>
) -> Result<(), Error>

Attach user data to self for the given key.

pub fn user_data<T: 'static>(
    &self,
    key: &'static UserDataKey<T>
) -> Option<Rc<T>>

Return the user data previously attached to self with the given key, if any.

pub fn user_data_ptr<T: 'static>(
    &self,
    key: &'static UserDataKey<T>
) -> Option<NonNull<T>>

Return the user data previously attached to self with the given key, if any, without incrementing the reference count.

The pointer is valid when it is returned from this method, until the cairo object that self represents is destroyed or remove_user_data or set_user_data is called with the same key.

pub fn remove_user_data<T: 'static>(
    &self,
    key: &'static UserDataKey<T>
) -> Result<(), Error>

Unattached from self the user data associated with key, if any. If there is no other Rc strong reference, the data is destroyed.

impl Surface

pub fn flush(&self)

pub fn finish(&self)

pub fn type_(&self) -> SurfaceType

impl Surface

pub fn write_to_png<W: Write>(&self, stream: &mut W) -> Result<(), IoError>

This function writes the surface as a PNG image to the given stream.

If the underlying surface does not support being written as a PNG, this will return Error::SurfaceTypeMismatch

impl Surface

pub fn finish_output_stream(&self) -> Result<Box<dyn Any>, StreamWithError>

Finish the surface, then remove and return the output stream if any.

This calls Surface::finish, to make sure pending writes are done.

This is relevant for surfaces created for example with crate::PdfSurface::for_stream.

Use Box::downcast to recover the concrete stream type.

Panics

This method panics if:

• This method was already called for this surface, or
• This surface was not created with an output stream in the first place, or
• A previous write to this surface panicked, or
• A previous write happened while another write was ongoing, or
• A write is ongoing now.

The latter two cases can only occur with a pathological output stream type that accesses the same surface again from Write::write_all.

Trait Implementations

impl AsRef<Surface> for ImageSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for PdfSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for PsSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for QuartzSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for RecordingSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for Surface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for SvgSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for Win32Surface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Surface> for XCBSurface

fn as_ref(&self) -> &Surface

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Surface

fn clone(&self) -> Surface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Surface

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

Formats the value using the given formatter.

impl Display for Surface

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

Formats the value using the given formatter.

impl Drop for Surface

fn drop(&mut self)

Executes the destructor for this type.

impl FromGlibPtrBorrow<*mut cairo_surface_t> for Surface

unsafe fn from_glib_borrow(ptr: *mut cairo_surface_t) -> Borrowed<Surface>

Safety

impl FromGlibPtrFull<*mut cairo_surface_t> for Surface

unsafe fn from_glib_full(ptr: *mut cairo_surface_t) -> Surface

Safety

impl FromGlibPtrNone<*mut cairo_surface_t> for Surface

unsafe fn from_glib_none(ptr: *mut cairo_surface_t) -> Surface

Safety

impl<'a> FromValue<'a> for &'a Surface

type Checker = GenericValueTypeOrNoneChecker<&'a Surface>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl<'a> FromValue<'a> for Surface

type Checker = GenericValueTypeOrNoneChecker<Surface>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl StaticType for Surface

fn static_type() -> Type

Returns the type identifier of Self.

impl<'a> ToGlibPtr<'a, *mut cairo_surface_t> for Surface

type Storage = &'a Surface

fn to_glib_none(&'a self) -> Stash<'a, *mut cairo_surface_t, Self>

Transfer: none.

fn to_glib_full(&self) -> *mut cairo_surface_t

Transfer: full.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

impl ToValue for Surface

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ToValueOptional for Surface

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl TryFrom<Surface> for ImageSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<ImageSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for PdfSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<PdfSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for PsSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<PsSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for QuartzSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<QuartzSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for RecordingSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<RecordingSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for SvgSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<SvgSurface, Surface>

Performs the conversion.

impl TryFrom<Surface> for Win32Surface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<Win32Surface, Surface>

Performs the conversion.

impl TryFrom<Surface> for XCBSurface

type Error = Surface

The type returned in the event of a conversion error.

fn try_from(surface: Surface) -> Result<XCBSurface, Surface>

Performs the conversion.

impl ValueType for Surface

type Type = Surface

Type to get the Type from.

impl ValueTypeOptional for Surface