Type Alias OrderedFontMgr

pub type OrderedFontMgr = RCHandle<SkOrderedFontMgr>;

Aliased Type

pub struct OrderedFontMgr(/* private fields */);

Implementations

impl OrderedFontMgr

pub fn new() -> Self

pub fn append(&mut self, font_mgr: impl Into<FontMgr>)

Methods from Deref<Target = FontMgr>

pub fn to_a_color_mode(&self) -> Option<(Color, BlendMode)>

If the filter can be represented by a source color plus Mode, this returns the color and mode appropriately. If not, this returns None and ignores the parameters.

pub fn to_a_color_matrix(&self) -> Option<[scalar; 20]>

If the filter can be represented by a 5x4 matrix, this returns the matrix appropriately. If not, this returns None and ignores the parameter.

pub fn is_alpha_unchanged(&self) -> bool

Returns true if the filter is guaranteed to never change the alpha of a color it filters.

pub fn filter_color(&self, color: impl Into<Color>) -> Color

👎Deprecated since 0.79.0: Use filter_color4f()

pub fn filter_color4f( &self, color: impl Into<Color4f>, src_color_space: Option<&ColorSpace>, dst_color_space: Option<&ColorSpace>, ) -> Color4f

Converts the src color (in src colorspace), into the dst colorspace, then applies this filter to it, returning the filtered color in the dst colorspace.

pub fn composed(&self, inner: impl Into<ColorFilter>) -> Option<Self>

Construct a color filter whose effect is to first apply the inner filter and then apply this filter, applied to the output of the inner filter.

result = this(inner(…))

pub fn with_working_color_space( &self, color_space: impl Into<ColorSpace>, ) -> Option<Self>

Return a color filter that will compute this filter in a specific color space. By default all filters operate in the destination (surface) color space. This allows filters like Blend and Matrix, or runtime color filters to perform their math in a known space.

pub fn to_xyzd50_hash(&self) -> XYZD50Hash

pub fn with_linear_gamma(&self) -> Self

pub fn with_srgb_gamma(&self) -> Self

pub fn with_color_spin(&self) -> Self

pub fn is_srgb(&self) -> bool

pub fn serialize(&self) -> Data

pub fn transfer_fn(&self) -> ColorSpaceTransferFn

pub fn inv_transfer_fn(&self) -> ColorSpaceTransferFn

pub fn transfer_fn_hash(&self) -> u32

pub fn hash(&self) -> u64

pub fn alpha_table(&self) -> &[u8; 256]

pub fn red_table(&self) -> &[u8; 256]

pub fn green_table(&self) -> &[u8; 256]

pub fn blue_table(&self) -> &[u8; 256]

pub fn length(&self) -> scalar

pub fn pos_tan(&self, distance: scalar) -> Option<(Point, Vector)>

pub fn get_matrix( &self, distance: scalar, flags: impl Into<Option<MatrixFlags>>, ) -> Option<Matrix>

pub fn segment( &self, start_d: scalar, stop_d: scalar, path_builder: &mut PathBuilder, start_with_move_to: bool, ) -> bool

pub fn is_closed(&self) -> bool

pub fn verbs(&self) -> ForwardVerbIterator<'_>

pub fn size(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_bytes(&self) -> &[u8]

pub fn copy_range(&self, offset: usize, buffer: &mut [u8]) -> &Self

pub fn is_empty(&self) -> bool

pub fn count(&self) -> usize

pub fn at_size(&self, index: usize) -> usize

pub fn at(&self, index: usize) -> &[u8]

pub unsafe fn at_t<T: Copy>(&self, index: usize) -> &[T]

pub fn at_str(&self, index: usize) -> &CStr

pub fn iter(&self) -> Iter<'_>

pub fn count_families(&self) -> usize

pub fn family_name(&self, index: usize) -> String

pub fn family_names(&self) -> impl Iterator<Item = String> + use<'_>

pub fn new_styleset(&self, index: usize) -> FontStyleSet

👎Deprecated since 0.41.0: Use new_style_set

pub fn new_style_set(&self, index: usize) -> FontStyleSet

pub fn match_family(&self, family_name: impl AsRef<str>) -> FontStyleSet

pub fn match_family_style( &self, family_name: impl AsRef<str>, style: FontStyle, ) -> Option<Typeface>

pub fn match_family_style_character( &self, family_name: impl AsRef<str>, style: FontStyle, bcp_47: &[&str], character: Unichar, ) -> Option<Typeface>

pub fn match_face_style( &self, _typeface: impl AsRef<Typeface>, _style: FontStyle, ) -> !

👎Deprecated since 0.35.0: Removed without replacement

pub fn new_from_data( &self, bytes: &[u8], ttc_index: impl Into<Option<usize>>, ) -> Option<Typeface>

pub fn legacy_make_typeface<'a>( &self, family_name: impl Into<Option<&'a str>>, style: FontStyle, ) -> Option<Typeface>

pub fn image_info(&self) -> &ImageInfo

Returns a ImageInfo describing the width, height, color type, alpha type, and color space of the Image.

Returns: image info of Image.

pub fn width(&self) -> i32

Returns pixel count in each row.

Returns: pixel width in Image

pub fn height(&self) -> i32

Returns pixel row count.

Returns: pixel height in Image

pub fn dimensions(&self) -> ISize

Returns ISize { width(), height() }.

Returns: integral size of width() and height()

pub fn bounds(&self) -> IRect

Returns IRect { 0, 0, width(), height() }.

Returns: integral rectangle from origin to width() and height()

pub fn unique_id(&self) -> u32

Returns value unique to image. Image contents cannot change after Image is created. Any operation to create a new Image will receive generate a new unique number.

Returns: unique identifier

pub fn alpha_type(&self) -> AlphaType

Returns AlphaType.

AlphaType returned was a parameter to an Image constructor, or was parsed from encoded data.

Returns: AlphaType in Image

example: https://fiddle.skia.org/c/@Image_alphaType

pub fn color_type(&self) -> ColorType

Returns ColorType if known; otherwise, returns ColorType::Unknown.

Returns: ColorType of Image

example: https://fiddle.skia.org/c/@Image_colorType

pub fn color_space(&self) -> Option<ColorSpace>

Returns a smart pointer to ColorSpace, the range of colors, associated with Image. The smart pointer tracks the number of objects sharing this ColorSpace reference so the memory is released when the owners destruct.

The returned ColorSpace is immutable.

ColorSpace returned was passed to an Image constructor, or was parsed from encoded data. ColorSpace returned may be ignored when Image is drawn, depending on the capabilities of the crate::Surface receiving the drawing.

Returns: ColorSpace in Image, or None, wrapped in a smart pointer

example: https://fiddle.skia.org/c/@Image_refColorSpace

pub fn is_alpha_only(&self) -> bool

Returns true if Image pixels represent transparency only. If true, each pixel is packed in 8 bits as defined by ColorType::Alpha8.

Returns: true if pixels represent a transparency mask

example: https://fiddle.skia.org/c/@Image_isAlphaOnly

pub fn is_opaque(&self) -> bool

Returns true if pixels ignore their alpha value and are treated as fully opaque.

Returns: true if AlphaType is AlphaType::Opaque

pub fn to_shader<'a>( &self, tile_modes: impl Into<Option<(TileMode, TileMode)>>, sampling: impl Into<SamplingOptions>, local_matrix: impl Into<Option<&'a Matrix>>, ) -> Option<Shader>

Make a shader with the specified tiling and mipmap sampling.

pub fn to_raw_shader<'a>( &self, tile_modes: impl Into<Option<(TileMode, TileMode)>>, sampling: impl Into<SamplingOptions>, local_matrix: impl Into<Option<&'a Matrix>>, ) -> Option<Shader>

to_raw_shader functions like to_shader, but for images that contain non-color data. This includes images encoding things like normals, material properties (eg, roughness), heightmaps, or any other purely mathematical data that happens to be stored in an image. These types of images are useful with some programmable shaders (see: crate::RuntimeEffect).

Raw image shaders work like regular image shaders (including filtering and tiling), with a few major differences:

• No color space transformation is ever applied (the color space of the image is ignored).
• Images with an alpha type of Unpremul are not automatically premultiplied.
• Bicubic filtering is not supported. If SamplingOptions::use_cubic is true, these factories will return None.

pub fn peek_pixels(&self) -> Option<Pixmap<'_>>

Copies Image pixel address, row bytes, and ImageInfo to pixmap, if address is available, and returns true. If pixel address is not available, return false and leave pixmap unchanged.

• pixmap storage for pixel state if pixels are readable; otherwise, ignored

Returns: true if Image has direct access to pixels

example: https://fiddle.skia.org/c/@Image_peekPixels

pub fn is_texture_backed(&self) -> bool

Returns true if the contents of Image was created on or uploaded to GPU memory, and is available as a GPU texture.

Returns: true if Image is a GPU texture

example: https://fiddle.skia.org/c/@Image_isTextureBacked

pub fn texture_size(&self) -> usize

Returns an approximation of the amount of texture memory used by the image. Returns zero if the image is not texture backed or if the texture has an external format.

pub fn is_valid(&self, recorder: Option<&mut dyn Recorder>) -> bool

Returns true if Image can be drawn on either raster surface or GPU surface. If recorder is None, tests if SkImage draws on raster surface; otherwise, tests if SkImage draws on the associated GPU surface.

Image backed by GPU texture may become invalid if associated context is invalid. lazy image may be invalid and may not draw to raster surface or GPU surface or both.

• context GPU context

Returns: true if Image can be drawn

example: https://fiddle.skia.org/c/@Image_isValid

pub fn make_scaled( &self, info: &ImageInfo, scaling: impl Into<SamplingOptions>, ) -> Option<Image>

Create a new image by copying this image and scaling to fit the ImageInfo’s dimensions and converting the pixels into the ImageInfo’s crate::ColorInfo.

This is done retaining the domain (backend) of the image (e.g. gpu, raster).

Returns None if the requested crate::ColorInfo is not supported, its dimensions are out of range.

pub fn flush<'a>( &self, context: &mut DirectContext, flush_info: impl Into<Option<&'a FlushInfo>>, ) -> SemaphoresSubmitted

👎Deprecated since 0.63.0: use gpu::DirectContext::flush()

See Self::flush_with_info()

pub fn flush_with_info( &self, context: &mut DirectContext, flush_info: &FlushInfo, ) -> SemaphoresSubmitted

👎Deprecated since 0.46.0: use gpu::DirectContext::flush()

Flushes any pending uses of texture-backed images in the GPU backend. If the image is not texture-backed (including promise texture images) or if the gpu::DirectContext does not have the same context ID as the context backing the image then this is a no-op.

If the image was not used in any non-culled draws in the current queue of work for the passed gpu::DirectContext then this is a no-op unless the gpu::FlushInfo contains semaphores or a finish proc. Those are respected even when the image has not been used.

• context the context on which to flush pending usages of the image.
• info flush options

pub fn flush_and_submit(&self, context: &mut DirectContext)

👎Deprecated since 0.63.0: use gpu::DirectContext::flush_and_submit()

Version of flush() that uses a default gpu::FlushInfo. Also submits the flushed work to the GPU.

pub fn backend_texture( &self, flush_pending_gr_context_io: bool, ) -> Option<(BackendTexture, SurfaceOrigin)>

👎Deprecated since 0.63.0: use gpu::images::get_backend_texture_from_image()

Retrieves the back-end texture. If Image has no back-end texture, Noneis returned.

If flush_pending_gr_context_io is true, completes deferred I/O operations.

If origin in not None, copies location of content drawn into Image.

• flush_pending_gr_context_io flag to flush outstanding requests

Returns: back-end API texture handle; invalid on failure

pub fn read_pixels_with_context<'a, P>( &self, context: impl Into<Option<&'a mut DirectContext>>, dst_info: &ImageInfo, pixels: &mut [P], dst_row_bytes: usize, src: impl Into<IPoint>, caching_hint: CachingHint, ) -> bool

Copies crate::Rect of pixels from Image to dst_pixels. Copy starts at offset (src_x, src_y), and does not exceed Image (width(), height()).

Graphite has deprecated this API in favor of the equivalent asynchronous API on skgpu::graphite::Context (with an optional explicit synchronization).

dst_info specifies width, height, ColorType, AlphaType, and ColorSpace of destination. dst_row_bytes specifies the gap from one destination row to the next. Returns true if pixels are copied. Returns false if:

• dst_info.addr() equals None
• dst_row_bytes is less than dst_info.min_row_bytes()
• crate::PixelRef is None

Pixels are copied only if pixel conversion is possible. If Image ColorType is ColorType::Gray8, or ColorType::Alpha8; dst_info.color_type() must match. If Image ColorType is ColorType::Gray8, dst_info.color_space() must match. If Image AlphaType is AlphaType::Opaque, dst_info.alpha_type() must match. If Image ColorSpace is None, dst_info.color_space() must match. Returns false if pixel conversion is not possible.

src_x and src_y may be negative to copy only top or left of source. Returns false if width() or height() is zero or negative. Returns false if abs(src_x) >= Image width(), or if abs(src_y) >= Image height().

If caching_hint is CachingHint::Allow, pixels may be retained locally. If caching_hint is CachingHint::Disallow, pixels are not added to the local cache.

• context the gpu::DirectContext in play, if it exists
• dst_info destination width, height, ColorType, AlphaType, ColorSpace
• dst_pixels destination pixel storage
• dst_row_bytes destination row length
• src_x column index whose absolute value is less than width()
• src_y row index whose absolute value is less than height()
• caching_hint whether the pixels should be cached locally

Returns: true if pixels are copied to dst_pixels

pub fn read_pixels_to_pixmap_with_context<'a>( &self, context: impl Into<Option<&'a mut DirectContext>>, dst: &Pixmap<'_>, src: impl Into<IPoint>, caching_hint: CachingHint, ) -> bool

Copies a crate::Rect of pixels from Image to dst. Copy starts at (src_x, src_y), and does not exceed Image (width(), height()).

Graphite has deprecated this API in favor of the equivalent asynchronous API on skgpu::graphite::Context (with an optional explicit synchronization).

dst specifies width, height, ColorType, AlphaType, ColorSpace, pixel storage, and row bytes of destination. dst.row_bytes() specifics the gap from one destination row to the next. Returns true if pixels are copied. Returns false if:

• dst pixel storage equals None
• dst.row_bytes is less than ImageInfo::min_row_bytes
• crate::PixelRef is None

Pixels are copied only if pixel conversion is possible. If Image ColorType is ColorType::Gray8, or ColorType::Alpha8; dst.color_type() must match. If Image ColorType is ColorType::Gray8, dst.color_space() must match. If Image AlphaType is AlphaType::Opaque, dst.alpha_type() must match. If Image ColorSpace is None, dst.color_space() must match. Returns false if pixel conversion is not possible.

src_x and src_y may be negative to copy only top or left of source. Returns false if width() or height() is zero or negative. Returns false if abs(src_x) >= Image width(), or if abs(src_y) >= Image height().

If caching_hint is CachingHint::Allow, pixels may be retained locally. If caching_hint is CachingHint::Disallow, pixels are not added to the local cache.

• context the gpu::DirectContext in play, if it exists
• dst destination Pixmap:ImageInfo, pixels, row bytes
• src_x column index whose absolute value is less than width()
• src_y row index whose absolute value is less than height()
• caching_hint whether the pixels should be cached locally_z

Returns: true if pixels are copied to dst

pub fn read_pixels<P>( &self, dst_info: &ImageInfo, pixels: &mut [P], dst_row_bytes: usize, src: impl Into<IPoint>, caching_hint: CachingHint, ) -> bool

See Self::read_pixels_with_context()

pub unsafe fn read_pixels_to_pixmap( &self, dst: &Pixmap<'_>, src: impl Into<IPoint>, caching_hint: CachingHint, ) -> bool

See Self::read_pixels_to_pixmap_with_context()

pub fn scale_pixels( &self, dst: &Pixmap<'_>, sampling: impl Into<SamplingOptions>, caching_hint: impl Into<Option<CachingHint>>, ) -> bool

Copies Image to dst, scaling pixels to fit dst.width() and dst.height(), and converting pixels to match dst.color_type() and dst.alpha_type(). Returns true if pixels are copied. Returns false if dst.addr() is None, or dst.row_bytes() is less than dst ImageInfo::min_row_bytes.

Pixels are copied only if pixel conversion is possible. If Image ColorType is ColorType::Gray8, or ColorType::Alpha8; dst.color_type() must match. If Image ColorType is ColorType::Gray8, dst.color_space() must match. If Image AlphaType is AlphaType::Opaque, dst.alpha_type() must match. If Image ColorSpace is None, dst.color_space() must match. Returns false if pixel conversion is not possible.

If caching_hint is CachingHint::Allow, pixels may be retained locally. If caching_hint is CachingHint::Disallow, pixels are not added to the local cache.

• dst destination Pixmap:ImageInfo, pixels, row bytes

Returns: true if pixels are scaled to fit dst

pub fn encode_to_data_with_context( &self, context: impl Into<Option<DirectContext>>, image_format: EncodedImageFormat, quality: impl Into<Option<u32>>, ) -> Option<Data>

👎Deprecated since 0.63.0: Use encode

Encodes Image pixels, returning result as Data.

Returns None if encoding fails, or if encoded_image_format is not supported.

Image encoding in a format requires both building with one or more of: SK_ENCODE_JPEG, SK_ENCODE_PNG, SK_ENCODE_WEBP; and platform support for the encoded format.

If SK_BUILD_FOR_MAC or SK_BUILD_FOR_IOS is defined, encoded_image_format can additionally be one of: EncodedImageFormat::ICO, EncodedImageFormat::BMP, EncodedImageFormat::GIF.

quality is a platform and format specific metric trading off size and encoding error. When used, quality equaling 100 encodes with the least error. quality may be ignored by the encoder.

• context - the gpu::DirectContext in play, if it exists; can be None
• encoded_image_format - one of: EncodedImageFormat::JPEG, EncodedImageFormat::PNG, EncodedImageFormat::WEBP
• quality - encoder specific metric with 100 equaling best

Returns: encoded Image, or None

example: https://fiddle.skia.org/c/@Image_encodeToData

pub fn encode_to_data(&self, image_format: EncodedImageFormat) -> Option<Data>

👎Deprecated since 0.63.0: Support for encoding GPU backed images without a context was removed, use encode_to_data_with_context instead

See Self::encode_to_data_with_quality

pub fn encode_to_data_with_quality( &self, image_format: EncodedImageFormat, quality: u32, ) -> Option<Data>

👎Deprecated since 0.63.0: Support for encoding GPU backed images without a context was removed, use encode_to_data_with_context instead

Encodes Image pixels, returning result as Data.

Returns None if encoding fails, or if encoded_image_format is not supported.

Image encoding in a format requires both building with one or more of: SK_ENCODE_JPEG, SK_ENCODE_PNG, SK_ENCODE_WEBP; and platform support for the encoded format.

If SK_BUILD_FOR_MAC or SK_BUILD_FOR_IOS is defined, encoded_image_format can additionally be one of: EncodedImageFormat::ICO, EncodedImageFormat::BMP, EncodedImageFormat::GIF.

quality is a platform and format specific metric trading off size and encoding error. When used, quality equaling 100 encodes with the least error. quality may be ignored by the encoder.

• encoded_image_format one of: EncodedImageFormat::JPEG, EncodedImageFormat::PNG, EncodedImageFormat::WEBP
• quality encoder specific metric with 100 equaling best

Returns: encoded Image, or None

example: https://fiddle.skia.org/c/@Image_encodeToData

pub fn encoded_data(&self) -> Option<Data>

Returns encoded Image pixels as Data, if Image was created from supported encoded stream format. Platform support for formats vary and may require building with one or more of: SK_ENCODE_JPEG, SK_ENCODE_PNG, SK_ENCODE_WEBP.

Returns None if Image contents are not encoded.

Returns: encoded Image, or None

example: https://fiddle.skia.org/c/@Image_refEncodedData

pub fn make_subset( &self, recorder: Option<&mut dyn Recorder>, subset: impl AsRef<IRect>, required_properties: RequiredProperties, ) -> Option<Image>

Returns subset of this image.

Returns None if any of the following are true:

• Subset is empty
• Subset is not contained inside the image’s bounds
• Pixels in the image could not be read or copied
• This image is texture-backed and the provided context is null or does not match the source image’s context.

If the source image was texture-backed, the resulting image will be texture-backed also. Otherwise, the returned image will be raster-backed.

• recorder - the recorder of the source image (None is ok if the source image was texture-backed).
• subset - bounds of returned Image
• required_properties - properties the returned Image must possess (e.g. mipmaps)

Returns: the subsetted image, or None

pub fn has_mipmaps(&self) -> bool

Returns true if the image has mipmap levels.

pub fn with_default_mipmaps(&self) -> Option<Image>

Returns an image with the same “base” pixels as the this image, but with mipmap levels automatically generated and attached.

pub fn new_texture_image( &self, context: &mut DirectContext, mipmapped: Mipmapped, ) -> Option<Image>

See Self::new_texture_image_budgeted

pub fn new_texture_image_budgeted( &self, direct_context: &mut DirectContext, mipmapped: Mipmapped, budgeted: Budgeted, ) -> Option<Image>

Returns Image backed by GPU texture associated with context. Returned Image is compatible with crate::Surface created with dst_color_space. The returned Image respects mipmapped setting; if mipmapped equals gpu::Mipmapped::Yes, the backing texture allocates mip map levels.

The mipmapped parameter is effectively treated as No if MIP maps are not supported by the GPU.

Returns original Image if the image is already texture-backed, the context matches, and mipmapped is compatible with the backing GPU texture. crate::Budgeted is ignored in this case.

Returns None if context is None, or if Image was created with another gpu::DirectContext.

• direct_context the gpu::DirectContext in play, if it exists
• mipmapped whether created Image texture must allocate mip map levels
• budgeted whether to count a newly created texture for the returned image counts against the context’s budget.

Returns: created Image, or None

pub fn to_non_texture_image(&self) -> Option<Image>

👎Deprecated since 0.64.0: use make_non_texture_image()

Returns raster image or lazy image. Copies Image backed by GPU texture into CPU memory if needed. Returns original Image if decoded in raster bitmap, or if encoded in a stream.

Returns None if backed by GPU texture and copy fails.

Returns: raster image, lazy image, or None

example: https://fiddle.skia.org/c/@Image_makeNonTextureImage

pub fn make_non_texture_image<'a>( &self, context: impl Into<Option<&'a mut DirectContext>>, ) -> Option<Image>

Returns raster image or lazy image. Copies Image backed by GPU texture into CPU memory if needed. Returns original Image if decoded in raster bitmap, or if encoded in a stream.

Returns None if backed by GPU texture and copy fails.

Returns: raster image, lazy image, or None

example: https://fiddle.skia.org/c/@Image_makeNonTextureImage

pub fn to_raster_image( &self, caching_hint: impl Into<Option<CachingHint>>, ) -> Option<Image>

👎Deprecated since 0.64.0: use make_raster_image()

Returns raster image. Copies Image backed by GPU texture into CPU memory, or decodes Image from lazy image. Returns original Image if decoded in raster bitmap.

Returns None if copy, decode, or pixel read fails.

If caching_hint is CachingHint::Allow, pixels may be retained locally. If caching_hint is CachingHint::Disallow, pixels are not added to the local cache.

Returns: raster image, or None

example: https://fiddle.skia.org/c/@Image_makeRasterImage

pub fn make_raster_image<'a>( &self, context: impl Into<Option<&'a mut DirectContext>>, caching_hint: impl Into<Option<CachingHint>>, ) -> Option<Image>

Returns raster image. Copies Image backed by GPU texture into CPU memory, or decodes Image from lazy image. Returns original Image if decoded in raster bitmap.

Returns None if copy, decode, or pixel read fails.

If caching_hint is CachingHint::Allow, pixels may be retained locally. If caching_hint is CachingHint::Disallow, pixels are not added to the local cache.

Returns: raster image, or None

example: https://fiddle.skia.org/c/@Image_makeRasterImage

pub fn new_with_filter( &self, _context: Option<&mut RecordingContext>, filter: &ImageFilter, clip_bounds: impl Into<IRect>, subset: impl Into<IRect>, ) -> Option<(Image, IRect, IPoint)>

👎Deprecated since 0.67.0: use images::make_with_filter()

Creates filtered Image. filter processes original Image, potentially changing color, position, and size. subset is the bounds of original Image processed by filter. clip_bounds is the expected bounds of the filtered Image. out_subset is required storage for the actual bounds of the filtered Image. offset is required storage for translation of returned Image.

Returns None if Image could not be created or if the recording context provided doesn’t match the GPU context in which the image was created. If None is returned, out_subset and offset are undefined.

Useful for animation of ImageFilter that varies size from frame to frame. Returned Image is created larger than required by filter so that GPU texture can be reused with different sized effects. out_subset describes the valid bounds of GPU texture returned. offset translates the returned Image to keep subsequent animation frames aligned with respect to each other.

• context the gpu::RecordingContext in play - if it exists
• filter how Image is sampled when transformed
• subset bounds of Image processed by filter
• clip_bounds expected bounds of filtered Image
• out_subset storage for returned Image bounds
• offset storage for returned Image translation

Returns: filtered Image, or None

pub fn is_lazy_generated(&self) -> bool

Returns true if Image is backed by an image-generator or other service that creates and caches its pixels or texture on-demand.

Returns: true if Image is created as needed

example: https://fiddle.skia.org/c/@Image_isLazyGenerated_a example: https://fiddle.skia.org/c/@Image_isLazyGenerated_b

pub fn make_color_space( &self, recorder: Option<&mut dyn Recorder>, color_space: impl Into<Option<ColorSpace>>, required_properties: RequiredProperties, ) -> Option<Image>

Creates Image in target ColorSpace. Returns None if Image could not be created.

Returns original Image if it is in target ColorSpace. Otherwise, converts pixels from Image ColorSpace to target ColorSpace. If Image color_space() returns None, Image ColorSpace is assumed to be s_rgb.

If this image is graphite-backed, the recorder parameter is required.

• target_color_space - ColorSpace describing color range of returned Image
• recorder - The Recorder in which to create the new image
• required_properties - properties the returned Image must possess (e.g. mipmaps)

Returns: created Image in target ColorSpace

pub fn reinterpret_color_space( &self, new_color_space: impl Into<ColorSpace>, ) -> Option<Image>

Creates a new Image identical to this one, but with a different ColorSpace. This does not convert the underlying pixel data, so the resulting image will draw differently.

pub fn filter_bounds<'a>( &self, src: impl AsRef<IRect>, ctm: &Matrix, map_direction: MapDirection, input_rect: impl Into<Option<&'a IRect>>, ) -> IRect

pub fn color_filter_node(&self) -> Option<ColorFilter>

pub fn to_a_color_filter(&self) -> Option<ColorFilter>

pub fn count_inputs(&self) -> usize

pub fn input(&self, i: usize) -> Option<ImageFilter>

👎Deprecated: use get_input()

pub fn get_input(&self, i: usize) -> Option<ImageFilter>

pub fn inputs(&self) -> impl Iterator<Item = Option<ImageFilter>> + use<'_>

pub fn compute_fast_bounds(&self, bounds: impl AsRef<Rect>) -> Rect

pub fn can_compute_fast_bounds(&self) -> bool

pub fn with_local_matrix(&self, matrix: &Matrix) -> Option<ImageFilter>

pub fn filter_path( &self, src: &Path, stroke_rec: &StrokeRec, cull_rect: impl AsRef<Rect>, ) -> Option<(PathBuilder, StrokeRec)>

pub fn filter_path_inplace( &self, dst: &mut PathBuilder, src: &Path, stroke_rec: &mut StrokeRec, cull_rect: impl AsRef<Rect>, ) -> bool

pub fn filter_path_inplace_with_matrix( &self, dst: &mut PathBuilder, src: &Path, stroke_rec: &mut StrokeRec, cull_rect: impl AsRef<Rect>, ctm: &Matrix, ) -> bool

pub fn needs_ctm(&self) -> bool

pub fn playback(&self, canvas: &Canvas)

pub fn cull_rect(&self) -> Rect

pub fn unique_id(&self) -> u32

pub fn serialize(&self) -> Data

pub fn approximate_op_count(&self) -> usize

pub fn approximate_op_count_nested( &self, nested: impl Into<Option<bool>>, ) -> usize

pub fn approximate_bytes_used(&self) -> usize

pub fn to_shader<'a, 'b>( &self, tm: impl Into<Option<(TileMode, TileMode)>>, mode: FilterMode, local_matrix: impl Into<Option<&'a Matrix>>, tile_rect: impl Into<Option<&'b Rect>>, ) -> Shader

pub fn dimensions(&self) -> ISize

pub fn width(&self) -> i32

pub fn height(&self) -> i32

pub unsafe fn pixels(&self) -> *mut c_void

pub fn row_bytes(&self) -> usize

pub fn generation_id(&self) -> u32

pub fn is_immutable(&self) -> bool

pub fn is_opaque(&self) -> bool

Returns true if the shader is guaranteed to produce only opaque colors, subject to the crate::Paint using the shader to apply an opaque alpha value. Subclasses should override this to allow some optimizations.

pub fn image(&self) -> Option<(Image, Matrix, (TileMode, TileMode))>

Returns iff this shader is backed by a single Image. If not, returns None.

pub fn is_a_image(&self) -> bool

pub fn with_local_matrix(&self, matrix: &Matrix) -> Self

Return a shader that will apply the specified local_matrix to this shader. The specified matrix will be applied before any matrix associated with this shader.

pub fn with_color_filter(&self, color_filter: impl Into<ColorFilter>) -> Self

Create a new shader that produces the same colors as invoking this shader and then applying the color filter.

pub fn with_working_color_space( &self, input_cs: impl Into<Option<ColorSpace>>, output_cs: impl Into<Option<ColorSpace>>, ) -> Self

Return a shader that will compute this shader in a context such that any child shaders return RGBA values converted to the input_cs colorspace.

It is then assumed that the RGBA values returned by this shader have been transformed into output_cs by the shader being wrapped. By default, shaders are assumed to return values in the destination colorspace and premultiplied. Using a different output_cs than input_cs allows custom shaders to replace the color management Skia normally performs w/o forcing authors to otherwise manipulate surface/image color info to avoid unnecessary or incorrect work.

If the shader is not performing colorspace conversion but needs to operate in the input_cs then it should have output_cs be the same as input_cs. Regardless of the output_cs here, the RGBA values of the returned Shader are always converted from output_cs to the destination surface color space.

A None input_cs is assumed to be the destination CS. A None output_cs is assumed to be the input_cs.

pub fn width(&self) -> i32

Returns pixel count in each row; may be zero or greater.

Returns: number of pixel columns

pub fn height(&self) -> i32

Returns pixel row count; may be zero or greater.

Returns: number of pixel rows

pub fn image_info(&self) -> ImageInfo

Returns an ImageInfo describing the surface.

pub fn recording_context(&self) -> Option<RecordingContext>

Returns the recording context being used by the Surface.

Returns: the recording context, if available; None otherwise

pub fn direct_context(&self) -> Option<DirectContext>

rust-skia helper, not in Skia

pub fn props(&self) -> &SurfaceProps

Returns SurfaceProps for surface.

Returns: LCD striping orientation and setting for device independent fonts

pub fn bounds(&self) -> &Rect

pub fn unique_id(&self) -> u32

pub fn get_intercepts( &self, bounds: [scalar; 2], paint: Option<&Paint>, ) -> Vec<scalar>

pub fn font_style(&self) -> FontStyle

pub fn is_bold(&self) -> bool

pub fn is_italic(&self) -> bool

pub fn is_fixed_pitch(&self) -> bool

pub fn variation_design_position(&self) -> Option<Vec<Coordinate>>

pub fn variation_design_parameters(&self) -> Option<Vec<VariationAxis>>

pub fn unique_id(&self) -> TypefaceId

pub fn clone_with_arguments( &self, arguments: &FontArguments<'_, '_>, ) -> Option<Typeface>

pub fn serialize_stream(&self, write: impl Write, behavior: SerializeBehavior)

pub fn serialize(&self, behavior: SerializeBehavior) -> Data

pub fn unichars_to_glyphs(&self, uni: &[Unichar], glyphs: &mut [GlyphId])

pub fn str_to_glyphs( &self, str: impl AsRef<str>, glyphs: &mut [GlyphId], ) -> usize

pub fn text_to_glyphs( &self, text: impl EncodedText, glyphs: &mut [GlyphId], ) -> usize

pub fn unichar_to_glyph(&self, unichar: Unichar) -> GlyphId

pub fn count_glyphs(&self) -> usize

pub fn count_tables(&self) -> usize

pub fn table_tags(&self) -> Option<Vec<FontTableTag>>

👎Deprecated since 0.88.0: use read_table_tags

pub fn read_table_tags(&self) -> Option<Vec<FontTableTag>>

pub fn get_table_size(&self, tag: FontTableTag) -> Option<usize>

pub fn get_table_data(&self, tag: FontTableTag, data: &mut [u8]) -> usize

pub fn copy_table_data(&self, tag: FontTableTag) -> Option<Data>

pub fn units_per_em(&self) -> Option<i32>

pub fn get_kerning_pair_adjustments( &self, glyphs: &[GlyphId], adjustments: &mut [i32], ) -> bool

pub fn new_family_name_iterator(&self) -> impl Iterator<Item = LocalizedString>

pub fn family_name(&self) -> String

pub fn post_script_name(&self) -> Option<String>

pub fn resource_name(&self) -> Option<String>

pub fn to_font_data(&self) -> Option<(Vec<u8>, usize)>

pub fn bounds(&self) -> Rect

pub const MAX_CUSTOM_ATTRIBUTES: usize = 8usize

pub fn unique_id(&self) -> u32

pub fn mode(&self) -> VertexMode

👎Deprecated since 0.29.0: will be removed without replacement

pub fn bounds(&self) -> &Rect

pub fn has_colors(&self) -> bool

👎Deprecated since 0.29.0: will be removed without replacement

pub fn has_tex_coords(&self) -> bool

👎Deprecated since 0.29.0: will be removed without replacement

pub fn has_bones(&self) -> bool

👎Deprecated since 0.29.0: returns false

pub fn has_indices(&self) -> bool

👎Deprecated since 0.29.0: will be removed without replacement

pub fn vertex_count(&self) -> usize

👎Deprecated since 0.29.0: will be removed without replacement

pub fn index_count(&self) -> usize

👎Deprecated since 0.29.0: will be removed without replacement

pub fn positions(&self) -> &[Point]

👎Deprecated since 0.29.0: will be removed without replacement

pub fn tex_coords(&self) -> Option<&[Point]>

👎Deprecated since 0.29.0: will be removed without replacement

pub fn colors(&self) -> Option<&[Color]>

👎Deprecated since 0.29.0: will be removed without replacement

pub fn bone_indices(&self) -> Option<&[BoneIndices]>

👎Deprecated since 0.29.0: returns None

pub fn bone_weights(&self) -> Option<&[BoneWeights]>

👎Deprecated since 0.29.0: returns None

pub fn indices(&self) -> Option<&[u16]>

👎Deprecated since 0.29.0: will be removed without replacement

pub fn is_volatile(&self) -> bool

👎Deprecated since 0.29.0: returns false

pub fn apply_bones(&self, _bones: &[Bone]) -> !

👎Deprecated since 0.29.0: removed without replacement

pub fn approximate_size(&self) -> usize

pub fn encode(&self) -> !

👎Deprecated since 0.31.0: removed without replacement

pub fn as_image_filter<'a>( &self, crop_rect: impl Into<Option<&'a Rect>>, ) -> Option<ImageFilter>

pub fn make_shader<'a>( &self, uniforms: impl Into<Data>, children: &[ChildPtr], local_matrix: impl Into<Option<&'a Matrix>>, ) -> Option<Shader>

pub fn make_color_filter<'a>( &self, inputs: impl Into<Data>, children: impl Into<Option<&'a [ChildPtr]>>, ) -> Option<ColorFilter>

pub fn make_blender<'a>( &self, uniforms: impl Into<Data>, children: impl Into<Option<&'a [ChildPtr]>>, ) -> Option<Blender>

pub fn source(&self) -> &str

pub fn input_size(&self) -> usize

👎Deprecated since 0.35.0: Use uniform_size() instead

pub fn uniform_size(&self) -> usize

pub fn inputs(&self) -> &[Uniform]

👎Deprecated since 0.35.0: Use uniforms() instead

pub fn uniforms(&self) -> &[Uniform]

pub fn children(&self) -> &[Child]

pub fn find_input(&self, name: impl AsRef<str>) -> Option<&Uniform>

👎Deprecated since 0.35.0: Use find_uniform()

pub fn find_uniform(&self, name: impl AsRef<str>) -> Option<&Uniform>

pub fn find_child(&self, name: impl AsRef<str>) -> Option<&Child>

pub fn allow_shader(&self) -> bool

pub fn allow_color_filter(&self) -> bool

pub fn allow_blender(&self) -> bool

pub fn encode<'a>( &self, context: impl Into<Option<&'a mut DirectContext>>, format: EncodedImageFormat, quality: impl Into<Option<u32>>, ) -> Option<Data>

pub fn resource_cache_limit(&self) -> usize

pub fn resource_cache_usage(&self) -> ResourceCacheUsage

pub fn resource_cache_purgeable_bytes(&self) -> usize

pub fn supported_gpu_stats(&self) -> GpuStatsFlags

pub fn supports_distance_field_text(&self) -> bool

pub fn can_detect_new_vk_pipeline_cache_data(&self) -> bool

pub fn has_new_vk_pipeline_cache_data(&self) -> bool

pub fn compressed_backend_format( &self, compression: TextureCompressionType, ) -> BackendFormat

pub fn id(&self) -> DirectContextId

pub fn validate(&self) -> bool

pub fn extensions(&self) -> &Extensions

pub fn has_extension(&self, extension: impl AsRef<str>) -> bool

pub fn backend(&self) -> BackendAPI

pub fn default_backend_format( &self, ct: ColorType, renderable: Renderable, ) -> BackendFormat

pub fn compressed_backend_format( &self, compression_type: TextureCompressionType, ) -> BackendFormat

pub fn color_type_supported_as_surface(&self, color_type: ColorType) -> bool

pub fn max_texture_size(&self) -> i32

pub fn max_render_target_size(&self) -> i32

pub fn color_type_supported_as_image(&self, color_type: ColorType) -> bool

pub fn supports_protected_content(&self) -> bool

pub fn max_surface_sample_count_for_color_type( &self, color_type: ColorType, ) -> usize

pub fn copied(&self) -> Self

pub fn vk_image_layout(&self) -> VkImageLayout

👎Deprecated since 0.72.0: use gpu::vk::mutable_texture_states::get_vk_image_layout()

pub fn queue_family_index(&self) -> u32

👎Deprecated since 0.72.0: use gpu::vk::mutable_texture_states::get_vk_queue_family_index()

pub fn backend(&self) -> BackendApi

pub fn font_managers_count(&self) -> usize

pub fn fallback_manager(&self) -> Option<FontMgr>

pub fn font_fallback_enabled(&self) -> bool

pub fn paragraph_cache(&self) -> &ParagraphCache

pub fn family_name(&self) -> &str

pub fn alias(&self) -> &str

pub fn is_multi_frame(&self) -> bool

pub fn clip_path_units(&self) -> &BoundingBoxUnits

pub fn children(&self) -> &[Node]

pub fn children_typed(&self) -> Vec<TypedNode>

pub fn root(&self) -> Svg

pub fn render(&self, canvas: &Canvas)

pub fn input2(&self) -> &Input

pub fn mode(&self) -> &BlendMode

pub fn kind(&self) -> &ColorMatrixKind

pub fn values(&self) -> &[scalar]

pub fn table_values(&self) -> &[scalar]

pub fn amplitude(&self) -> scalar

pub fn exponent(&self) -> scalar

pub fn intercept(&self) -> scalar

pub fn offset(&self) -> scalar

pub fn slope(&self) -> scalar

pub fn kind(&self) -> &FuncKind

pub fn input2(&self) -> &Input

pub fn k1(&self) -> scalar

pub fn k2(&self) -> scalar

pub fn k3(&self) -> scalar

pub fn k4(&self) -> scalar

pub fn operator(&self) -> &CompositeOperator

pub fn input2(&self) -> &Input

pub fn x_channel_selector(&self) -> &ChannelSelector

pub fn y_channel_selector(&self) -> &ChannelSelector

pub fn scale(&self) -> &scalar

pub fn std_deviation(&self) -> &StdDeviation

pub fn href(&self) -> &Iri

pub fn preserve_aspect_ratio(&self) -> &PreserveAspectRatio

pub fn azimuth(&self) -> scalar

pub fn elevation(&self) -> scalar

pub fn x(&self) -> scalar

pub fn y(&self) -> scalar

pub fn z(&self) -> scalar

pub fn x(&self) -> scalar

pub fn y(&self) -> scalar

pub fn z(&self) -> scalar

pub fn points_at_x(&self) -> scalar

pub fn points_at_y(&self) -> scalar

pub fn points_at_z(&self) -> scalar

pub fn specular_exponent(&self) -> scalar

pub fn limiting_cone_angle(&self) -> Option<scalar>

pub fn surface_scale(&self) -> scalar

pub fn kernel_unit_length(&self) -> Option<KernelUnitLength>

pub fn specular_constant(&self) -> scalar

pub fn specular_exponent(&self) -> scalar

pub fn diffuse_constant(&self) -> scalar

pub fn input(&self) -> &Input

pub fn operator(&self) -> &Operator

pub fn radius(&self) -> &Radius

pub fn dx(&self) -> scalar

pub fn dy(&self) -> scalar

pub fn base_frequency(&self) -> &TurbulenceBaseFrequency

pub fn num_octaves(&self) -> i32

pub fn seed(&self) -> scalar

pub fn turbulence_type(&self) -> &TurbulenceType

pub fn input(&self) -> &Input

pub fn result(&self) -> &Handle<SkString>

pub fn x(&self) -> Option<&Length>

pub fn y(&self) -> Option<&Length>

pub fn width(&self) -> Option<&Length>

pub fn height(&self) -> Option<&Length>

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn width(&self) -> &Length

pub fn height(&self) -> &Length

pub fn filter_units(&self) -> &BoundingBoxUnits

pub fn primitive_units(&self) -> &BoundingBoxUnits

pub fn x1(&self) -> &Length

pub fn y1(&self) -> &Length

pub fn x2(&self) -> &Length

pub fn y2(&self) -> &Length

pub fn cx(&self) -> &Length

pub fn cy(&self) -> &Length

pub fn r(&self) -> &Length

pub fn fx(&self) -> Option<&Length>

pub fn fy(&self) -> Option<&Length>

pub fn href(&self) -> &Iri

pub fn gradient_transform(&self) -> &Matrix

pub fn spread_method(&self) -> &SpreadMethod

pub fn gradient_units(&self) -> &BoundingBoxUnits

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn width(&self) -> &Length

pub fn height(&self) -> &Length

pub fn href(&self) -> &Iri

pub fn preserve_aspect_ratio(&self) -> &PreserveAspectRatio

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn width(&self) -> &Length

pub fn height(&self) -> &Length

pub fn mask_units(&self) -> &BoundingBoxUnits

pub fn mask_content_units(&self) -> &BoundingBoxUnits

pub fn tag(&self) -> NodeTag

pub fn clip_rule(&self) -> Option<&FillRule>

pub fn color_interpolation(&self) -> Option<&ColorSpace>

pub fn color_interpolation_filters(&self) -> Option<&ColorSpace>

pub fn color(&self) -> Option<&Color>

pub fn fill_rule(&self) -> Option<&FillRule>

pub fn fill(&self) -> Option<&Paint>

pub fn fill_opacity(&self) -> Option<scalar>

pub fn font_family(&self) -> Option<&FontFamily>

pub fn font_size(&self) -> Option<&FontSize>

pub fn font_style(&self) -> Option<&FontStyle>

pub fn font_weight(&self) -> Option<&FontWeight>

pub fn stroke(&self) -> Option<&Paint>

pub fn stroke_line_cap(&self) -> Option<&LineCap>

pub fn stroke_line_join(&self) -> Option<&LineJoin>

pub fn stroke_miter_limit(&self) -> Option<scalar>

pub fn stroke_opacity(&self) -> Option<scalar>

pub fn stroke_width(&self) -> Option<&Length>

pub fn text_anchor(&self) -> Option<&TextAnchor>

pub fn visibility(&self) -> Option<&Visibility>

pub fn clip_path(&self) -> Option<&IriFunc>

pub fn display(&self) -> Option<&Display>

pub fn mask(&self) -> Option<&IriFunc>

pub fn filter(&self) -> Option<&IriFunc>

pub fn opacity(&self) -> Option<scalar>

pub fn stop_color(&self) -> Option<&Fill>

pub fn stop_opacity(&self) -> Option<scalar>

pub fn flood_color(&self) -> Option<&Fill>

pub fn flood_opacity(&self) -> Option<scalar>

pub fn lighting_color(&self) -> Option<&Fill>

pub fn as_base(&self) -> &RCHandle<T::Base>

pub fn href(&self) -> &Iri

pub fn x(&self) -> Option<&Length>

pub fn y(&self) -> Option<&Length>

pub fn width(&self) -> Option<&Length>

pub fn height(&self) -> Option<&Length>

pub fn pattern_transform(&self) -> Option<&Matrix>

pub fn cx(&self) -> &Length

pub fn cy(&self) -> &Length

pub fn r(&self) -> &Length

pub fn cx(&self) -> &Length

pub fn cy(&self) -> &Length

pub fn rx(&self) -> Option<&Length>

pub fn ry(&self) -> Option<&Length>

pub fn x1(&self) -> &Length

pub fn y1(&self) -> &Length

pub fn x2(&self) -> &Length

pub fn y2(&self) -> &Length

pub fn path(&self) -> &Path

pub fn points(&self) -> &[Point]

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn width(&self) -> &Length

pub fn height(&self) -> &Length

pub fn rx(&self) -> Option<&Length>

pub fn ry(&self) -> Option<&Length>

pub fn offset(&self) -> &Length

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn width(&self) -> &Length

pub fn height(&self) -> &Length

pub fn preserve_aspect_ratio(&self) -> &PreserveAspectRatio

pub fn view_box(&self) -> Option<&Rect>

pub fn intrinsic_size(&self) -> Size

pub fn x(&self) -> &[Length]

pub fn y(&self) -> &[Length]

pub fn dx(&self) -> &[Length]

pub fn dy(&self) -> &[Length]

pub fn rotate(&self) -> &[scalar]

pub fn xml_space(&self) -> &XmlSpace

pub fn text(&self) -> &str

pub fn href(&self) -> &Iri

pub fn start_offset(&self) -> &Length

pub fn transform(&self) -> &Matrix

pub fn x(&self) -> &Length

pub fn y(&self) -> &Length

pub fn href(&self) -> &Iri

Trait Implementations

impl Debug for OrderedFontMgr

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

Formats the value using the given formatter.

impl Default for OrderedFontMgr

fn default() -> Self

Returns the “default value” for a type.

impl Deref for OrderedFontMgr

type Target = RCHandle<SkFontMgr>

The resulting type after dereferencing.

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

Dereferences the value.