pub struct Surface(/* private fields */);
Implementations§
source§impl Surface
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<ImageSurface, 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>
sourcepub fn set_user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>,
value: Rc<T>,
) -> 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
.
sourcepub fn user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>,
) -> Option<Rc<T>>
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.
sourcepub fn user_data_ptr<T: 'static>(
&self,
key: &'static UserDataKey<T>,
) -> Option<NonNull<T>>
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.
sourcepub fn remove_user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>,
) -> Result<(), Error>
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.
source§impl Surface
impl Surface
sourcepub fn write_to_png<W: Write>(&self, stream: &mut W) -> Result<(), IoError>
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
source§impl Surface
impl Surface
sourcepub fn finish_output_stream(&self) -> Result<Box<dyn Any>, StreamWithError>
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§
source§impl AsRef<Surface> for ImageSurface
impl AsRef<Surface> for ImageSurface
source§impl AsRef<Surface> for PdfSurface
impl AsRef<Surface> for PdfSurface
source§impl AsRef<Surface> for RecordingSurface
impl AsRef<Surface> for RecordingSurface
source§impl AsRef<Surface> for SvgSurface
impl AsRef<Surface> for SvgSurface
source§impl AsRef<Surface> for XCBSurface
impl AsRef<Surface> for XCBSurface
source§impl FromGlibPtrBorrow<*mut cairo_surface_t> for Surface
impl FromGlibPtrBorrow<*mut cairo_surface_t> for Surface
source§unsafe fn from_glib_borrow(ptr: *mut cairo_surface_t) -> Borrowed<Surface>
unsafe fn from_glib_borrow(ptr: *mut cairo_surface_t) -> Borrowed<Surface>
source§impl FromGlibPtrFull<*mut cairo_surface_t> for Surface
impl FromGlibPtrFull<*mut cairo_surface_t> for Surface
source§unsafe fn from_glib_full(ptr: *mut cairo_surface_t) -> Surface
unsafe fn from_glib_full(ptr: *mut cairo_surface_t) -> Surface
source§impl FromGlibPtrNone<*mut cairo_surface_t> for Surface
impl FromGlibPtrNone<*mut cairo_surface_t> for Surface
source§unsafe fn from_glib_none(ptr: *mut cairo_surface_t) -> Surface
unsafe fn from_glib_none(ptr: *mut cairo_surface_t) -> Surface
source§impl<'a> FromValue<'a> for &'a Surface
impl<'a> FromValue<'a> for &'a Surface
§type Checker = GenericValueTypeOrNoneChecker<&'a Surface>
type Checker = GenericValueTypeOrNoneChecker<&'a Surface>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl<'a> FromValue<'a> for Surface
impl<'a> FromValue<'a> for Surface
§type Checker = GenericValueTypeOrNoneChecker<Surface>
type Checker = GenericValueTypeOrNoneChecker<Surface>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl IntoGlibPtr<*mut cairo_surface_t> for Surface
impl IntoGlibPtr<*mut cairo_surface_t> for Surface
source§unsafe fn into_glib_ptr(self) -> *mut cairo_surface_t
unsafe fn into_glib_ptr(self) -> *mut cairo_surface_t
source§impl StaticType for Surface
impl StaticType for Surface
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl<'a> ToGlibPtr<'a, *mut cairo_surface_t> for Surface
impl<'a> ToGlibPtr<'a, *mut cairo_surface_t> for Surface
type Storage = PhantomData<&'a Surface>
source§fn to_glib_none(&'a self) -> Stash<'a, *mut cairo_surface_t, Self>
fn to_glib_none(&'a self) -> Stash<'a, *mut cairo_surface_t, Self>
source§fn to_glib_full(&self) -> *mut cairo_surface_t
fn to_glib_full(&self) -> *mut cairo_surface_t
source§fn to_glib_container(&'a self) -> Stash<'a, P, Self>
fn to_glib_container(&'a self) -> Stash<'a, P, Self>
source§impl ToValueOptional for Surface
impl ToValueOptional for Surface
source§fn to_value_optional(s: Option<&Self>) -> Value
fn to_value_optional(s: Option<&Self>) -> Value
Option
to a Value
.source§impl TryFrom<Surface> for ImageSurface
impl TryFrom<Surface> for ImageSurface
source§impl TryFrom<Surface> for PdfSurface
impl TryFrom<Surface> for PdfSurface
source§impl TryFrom<Surface> for RecordingSurface
impl TryFrom<Surface> for RecordingSurface
source§impl TryFrom<Surface> for SvgSurface
impl TryFrom<Surface> for SvgSurface
source§impl TryFrom<Surface> for XCBSurface
impl TryFrom<Surface> for XCBSurface
impl ValueTypeOptional for Surface
Auto Trait Implementations§
impl Freeze for Surface
impl RefUnwindSafe for Surface
impl !Send for Surface
impl !Sync for Surface
impl Unpin for Surface
impl UnwindSafe for Surface
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)