Struct RefHandle

pub struct RefHandle<N: NativeDrop>(/* private fields */);

A wrapper type that represents a native type with a pointer to the native object.

Implementations

impl RefHandle<SkDrawable_GpuDrawHandler>

pub fn draw(&mut self, info: &BackendDrawableInfo)

impl RefHandle<SkImageGenerator>

pub fn unique_id(&self) -> u32

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

pub fn info(&self) -> &ImageInfo

pub fn is_valid(&self, context: Option<&mut RecordingContext>) -> bool

pub fn is_protected(self) -> bool

pub fn get_pixels( &mut self, info: &ImageInfo, pixels: &mut [u8], row_bytes: usize, ) -> bool

pub fn query_yuva_info( &self, supported_data_types: &SupportedDataTypes, ) -> Option<YUVAPixmapInfo>

pub fn is_texture_generator(&self) -> bool

pub fn from_encoded(_encoded: impl Into<Data>) -> Option<Self>

👎Deprecated since 0.64.0: Removed, will return None. Use Image::deferred_from_encoded_data() or Codec::from_data()

impl RefHandle<GrBackendTexture>

pub unsafe fn new_gl( (width, height): (i32, i32), mipmapped: Mipmapped, gl_info: TextureInfo, ) -> Self

👎Deprecated since 0.67.0: use gpu::backend_textures::make_gl()

pub unsafe fn new_gl_with_label( (width, height): (i32, i32), mipmapped: Mipmapped, gl_info: TextureInfo, label: impl AsRef<str>, ) -> Self

👎Deprecated since 0.67.0: use gpu::backend_textures::make_gl()

pub unsafe fn new_vulkan( (width, height): (i32, i32), vk_info: &ImageInfo, ) -> Self

👎Deprecated since 0.67.0: use gpu::backend_textures::make_vk()

pub unsafe fn new_vulkan_with_label( (width, height): (i32, i32), vk_info: &ImageInfo, label: impl AsRef<str>, ) -> Self

👎Deprecated since 0.67.0: use gpu::backend_textures::make_vk()

pub unsafe fn new_metal( (width, height): (i32, i32), mipmapped: Mipmapped, mtl_info: &TextureInfo, ) -> Self

👎Deprecated since 0.74.0: use gpu::backend_textures::make_mtl()

pub unsafe fn new_metal_with_label( (width, height): (i32, i32), mipmapped: Mipmapped, mtl_info: &TextureInfo, label: impl AsRef<str>, ) -> Self

👎Deprecated since 0.74.0: use gpu::backend_textures::make_mtl()

pub fn dimensions(&self) -> ISize

pub fn width(&self) -> i32

pub fn height(&self) -> i32

pub fn label(&self) -> &str

pub fn mipmapped(&self) -> Mipmapped

pub fn has_mip_maps(&self) -> bool

👎Deprecated since 0.35.0: Use has_mipmaps()

pub fn has_mipmaps(&self) -> bool

pub fn backend(&self) -> BackendAPI

pub fn gl_texture_info(&self) -> Option<TextureInfo>

pub fn gl_texture_parameters_modified(&mut self)

pub fn vulkan_image_info(&self) -> Option<ImageInfo>

pub fn set_vulkan_image_layout(&mut self, layout: ImageLayout) -> &mut Self

pub fn metal_texture_info(&self) -> Option<TextureInfo>

pub fn backend_format(&self) -> BackendFormat

pub fn set_mutable_state(&mut self, state: &MutableTextureState)

pub fn is_protected(&self) -> bool

pub fn is_valid(&self) -> bool

👎Deprecated since 0.37.0: Invalid BackendTextures aren’t supported

pub fn is_same_texture(&mut self, texture: &BackendTexture) -> bool

impl RefHandle<skia_textlayout_Paragraph>

pub fn max_width(&self) -> scalar

pub fn height(&self) -> scalar

pub fn min_intrinsic_width(&self) -> scalar

pub fn max_intrinsic_width(&self) -> scalar

pub fn alphabetic_baseline(&self) -> scalar

pub fn ideographic_baseline(&self) -> scalar

pub fn longest_line(&self) -> scalar

pub fn did_exceed_max_lines(&self) -> bool

pub fn layout(&mut self, width: scalar)

pub fn paint(&self, canvas: &Canvas, p: impl Into<Point>)

pub fn get_rects_for_range( &self, range: Range<usize>, rect_height_style: RectHeightStyle, rect_width_style: RectWidthStyle, ) -> Vec<TextBox>

Returns a vector of bounding boxes that enclose all text between start and end glyph indexes, including start and excluding end

pub fn get_rects_for_placeholders(&self) -> Vec<TextBox>

pub fn get_glyph_position_at_coordinate( &self, p: impl Into<Point>, ) -> PositionWithAffinity

Returns the index of the glyph that corresponds to the provided coordinate, with the top left corner as the origin, and +y direction as down

pub fn get_word_boundary(&self, offset: u32) -> Range<usize>

Finds the first and last glyphs that define a word containing the glyph at index offset

pub fn get_line_metrics(&self) -> Vec<LineMetrics<'_>>

pub fn line_number(&self) -> usize

pub fn mark_dirty(&mut self)

pub fn unresolved_glyphs(&mut self) -> Option<usize>

This function will return the number of unresolved glyphs or None if not applicable (has not been shaped yet - valid case)

pub fn unresolved_codepoints(&mut self) -> Vec<Unichar>

pub fn visit<'a, F>(&mut self, visitor: F)

where F: FnMut(usize, Option<&'a VisitorInfo>),

pub fn extended_visit<'a, F>(&mut self, visitor: F)

where F: FnMut(usize, Option<&'a ExtendedVisitorInfo>),

pub fn get_path_at(&mut self, line_number: usize) -> (usize, Path)

Returns path for a given line

• line_number - a line number
• dest - a resulting path

Returns: a number glyphs that could not be converted to path

pub fn get_path(text_blob: &mut TextBlob) -> Path

Returns path for a text blob

• text_blob - a text blob

Returns: a path

pub fn contains_emoji(&mut self, text_blob: &mut TextBlob) -> bool

Checks if a given text blob contains glyph with emoji

• text_blob - a text blob

Returns: true if there is such a glyph

pub fn contains_color_font_or_bitmap( &mut self, text_blob: &mut TextBlob, ) -> bool

Checks if a given text blob contains colored font or bitmap

• text_blob - a text blob

Returns: true if there is such a glyph

pub fn get_line_number_at(&self, code_unit_index: TextIndex) -> Option<usize>

Finds the line number of the line that contains the given UTF-8 index.

• index - a UTF-8 TextIndex into the paragraph

Returns: the line number the glyph that corresponds to the given code_unit_index is in, or -1 if the code_unit_index is out of bounds, or when the glyph is truncated or ellipsized away.

pub fn get_line_number_at_utf16_offset( &self, code_unit_index: TextIndex, ) -> Option<usize>

Finds the line number of the line that contains the given UTF-16 index.

• index - a UTF-16 offset into the paragraph

Returns: the line number the glyph that corresponds to the given code_unit_index is in, or -1 if the code_unit_index is out of bounds, or when the glyph is truncated or ellipsized away.

pub fn get_line_metrics_at(&self, line_number: usize) -> Option<LineMetrics<'_>>

Returns line metrics info for the line

• line_number - a line number
• line_metrics - an address to return the info (in case of null just skipped)

Returns: true if the line is found; false if not

pub fn get_actual_text_range( &self, line_number: usize, include_spaces: bool, ) -> TextRange

Returns the visible text on the line (excluding a possible ellipsis)

• line_number - a line number
• include_spaces - indicates if the whitespaces should be included

Returns: the range of the text that is shown in the line

pub fn get_glyph_cluster_at( &self, code_unit_index: TextIndex, ) -> Option<GlyphClusterInfo>

Finds a glyph cluster for text index

• code_unit_index - a text index
• glyph_info - a glyph cluster info filled if not null

Returns: true if glyph cluster was found; false if not

pub fn get_closest_glyph_cluster_at( &self, d: impl Into<Point>, ) -> Option<GlyphClusterInfo>

Finds the closest glyph cluster for a visual text position

• dx - x coordinate
• dy - y coordinate
• glyph_info - a glyph cluster info filled if not null

Returns: true if glyph cluster was found; false if not (which usually means the paragraph is empty)

pub fn get_glyph_info_at_utf16_offset( &mut self, code_unit_index: usize, ) -> Option<GlyphInfo>

Retrieves the information associated with the glyph located at the given code_unit_index.

• code_unit_index - a UTF-16 offset into the paragraph
• glyph_info - an optional GlyphInfo struct to hold the information associated with the glyph found at the given index

Returns: false only if the offset is out of bounds

pub fn get_closest_utf16_glyph_info_at( &mut self, d: impl Into<Point>, ) -> Option<GlyphInfo>

Finds the information associated with the closest glyph to the given paragraph coordinates.

• d - x/y coordinate
• glyph_info - an optional GlyphInfo struct to hold the information associated with the glyph found. The text indices and text ranges are described using UTF-16 offsets

Returns: true if a grapheme cluster was found; false if not (which usually means the paragraph is empty)

pub fn get_font_at(&self, code_unit_index: TextIndex) -> Font

Returns the font that is used to shape the text at the position

• code_unit_index - text index

Returns: font info or an empty font info if the text is not found

pub fn get_font_at_utf16_offset(&mut self, code_unit_index: usize) -> Font

Returns the font used to shape the text at the given UTF-16 offset.

• code_unit_index - a UTF-16 offset in the paragraph

Returns: font info or an empty font info if the text is not found

pub fn get_fonts(&self) -> Vec<FontInfo>

Returns the information about all the fonts used to shape the paragraph text

Returns: a list of fonts and text ranges

impl RefHandle<skia_textlayout_ParagraphBuilder>

pub fn push_style(&mut self, style: &TextStyle) -> &mut Self

pub fn pop(&mut self) -> &mut Self

pub fn peek_style(&mut self) -> TextStyle

pub fn add_text(&mut self, str: impl AsRef<str>) -> &mut Self

pub fn add_placeholder( &mut self, placeholder_style: &PlaceholderStyle, ) -> &mut Self

pub fn build(&mut self) -> Paragraph

pub fn get_text(&mut self) -> &str

pub fn get_paragraph_style(&self) -> ParagraphStyle

pub fn reset(&mut self)

pub fn new( style: &ParagraphStyle, font_collection: impl Into<FontCollection>, ) -> Self

impl RefHandle<skia_textlayout_ParagraphStyle>

pub fn new() -> Self

pub fn strut_style(&self) -> &StrutStyle

pub fn set_strut_style(&mut self, strut_style: StrutStyle) -> &mut Self

pub fn text_style(&self) -> &TextStyle

pub fn set_text_style(&mut self, text_style: &TextStyle) -> &mut Self

pub fn text_direction(&self) -> TextDirection

pub fn set_text_direction(&mut self, direction: TextDirection) -> &mut Self

pub fn text_align(&self) -> TextAlign

pub fn set_text_align(&mut self, align: TextAlign) -> &mut Self

pub fn max_lines(&self) -> Option<usize>

pub fn set_max_lines(&mut self, lines: impl Into<Option<usize>>) -> &mut Self

pub fn ellipsis(&self) -> &str

pub fn set_ellipsis(&mut self, ellipsis: impl AsRef<str>) -> &mut Self

pub fn height(&self) -> scalar

pub fn set_height(&mut self, height: scalar) -> &mut Self

pub fn text_height_behavior(&self) -> TextHeightBehavior

pub fn set_text_height_behavior(&mut self, v: TextHeightBehavior) -> &mut Self

pub fn unlimited_lines(&self) -> bool

pub fn ellipsized(&self) -> bool

pub fn effective_align(&self) -> TextAlign

pub fn hinting_is_on(&self) -> bool

pub fn turn_hinting_off(&mut self) -> &mut Self

pub fn replace_tab_characters(&self) -> bool

pub fn set_replace_tab_characters(&mut self, value: bool) -> &mut Self

pub fn apply_rounding_hack(&self) -> bool

pub fn set_apply_rounding_hack(&mut self, value: bool) -> &mut Self

impl RefHandle<SkShaper>

pub fn new_primitive() -> Self

👎Deprecated since 0.74.0: use shapers::primitive::primitive_text()

pub fn new_shaper_driven_wrapper( fallback_font_mgr: impl Into<Option<FontMgr>>, ) -> Option<Self>

pub fn new_shape_then_wrap( fallback_font_mgr: impl Into<Option<FontMgr>>, ) -> Option<Self>

pub fn new_shape_dont_wrap_or_reorder( fallback_font_mgr: impl Into<Option<FontMgr>>, ) -> Option<Self>

👎Deprecated since 0.74.0: use shapers::hb::shape_dont_wrap_or_reorder()

pub fn purge_harf_buzz_cache()

pub fn new_core_text() -> Option<Self>

pub fn new(font_mgr: impl Into<Option<FontMgr>>) -> Self

pub fn purge_caches()

impl RefHandle<SkShaper_FontRunIterator>

pub fn current_font(&self) -> &Font

impl RefHandle<SkShaper>

pub fn new_font_mgr_run_iterator<'a>( utf8: &'a str, font: &Font, fallback: impl Into<Option<FontMgr>>, ) -> Borrows<'a, FontRunIterator>

pub fn new_trivial_font_run_iterator( font: &Font, utf8_bytes: usize, ) -> FontRunIterator

impl RefHandle<SkShaper_BiDiRunIterator>

pub fn current_level(&self) -> u8

impl RefHandle<SkShaper>

pub fn new_bidi_run_iterator( utf8: &str, bidi_level: u8, ) -> Option<Borrows<'_, BiDiRunIterator>>

pub fn new_icu_bidi_run_iterator( utf8: &str, level: u8, ) -> Option<Borrows<'_, BiDiRunIterator>>

pub fn new_trivial_bidi_run_iterator( bidi_level: u8, utf8_bytes: usize, ) -> BiDiRunIterator

👎Deprecated since 0.74.0: use shapers::primitive::trivial_bidi_run_iterator()

impl RefHandle<SkShaper_ScriptRunIterator>

pub fn current_script(&self) -> FourByteTag

impl RefHandle<SkShaper>

pub fn new_script_run_iterator( utf8: &str, script: FourByteTag, ) -> Borrows<'_, ScriptRunIterator>

pub fn new_hb_icu_script_run_iterator( utf8: &str, ) -> Borrows<'_, ScriptRunIterator>

pub fn new_trivial_script_run_iterator( bidi_level: u8, utf8_bytes: usize, ) -> ScriptRunIterator

👎Deprecated since 0.74.0: use shapers::primitive::trivial_script_run_iterator

impl RefHandle<SkShaper_LanguageRunIterator>

pub fn current_language(&self) -> &CStr

impl RefHandle<SkShaper>

pub fn new_std_language_run_iterator(utf8: &str) -> Option<LanguageRunIterator>

pub fn new_trivial_language_run_iterator( language: impl AsRef<str>, utf8_bytes: usize, ) -> LanguageRunIterator

impl RefHandle<SkShaper>

pub fn shape<'a, 'b: 'a>( &self, utf8: &str, font: &Font, left_to_right: bool, width: scalar, run_handler: &'b mut impl AsRunHandler<'a>, )

pub fn shape_with_iterators<'a, 'b: 'a>( &self, utf8: &str, font_run_iterator: &mut FontRunIterator, bidi_run_iterator: &mut BiDiRunIterator, script_run_iterator: &mut ScriptRunIterator, language_run_iterator: &mut LanguageRunIterator, width: scalar, run_handler: &'b mut impl AsRunHandler<'a>, )

pub fn shape_with_iterators_and_features<'a, 'b: 'a>( &self, utf8: &str, font_run_iterator: &mut FontRunIterator, bidi_run_iterator: &mut BiDiRunIterator, script_run_iterator: &mut ScriptRunIterator, language_run_iterator: &mut LanguageRunIterator, features: &[Feature], width: scalar, run_handler: &'b mut impl AsRunHandler<'a>, )

impl RefHandle<SkShaper>

pub fn shape_text_blob( &self, text: &str, font: &Font, left_to_right: bool, width: scalar, offset: impl Into<Point>, ) -> Option<(TextBlob, Point)>

impl RefHandle<Sk3DView>

pub fn new() -> Self

pub fn save(&mut self) -> &mut Self

pub fn restore(&mut self) -> &mut Self

pub fn translate(&mut self, d: impl Into<V3>) -> &mut Self

pub fn rotate_x(&mut self, deg: scalar) -> &mut Self

pub fn rotate_y(&mut self, deg: scalar) -> &mut Self

pub fn rotate_z(&mut self, deg: scalar) -> &mut Self

pub fn matrix(&self) -> Matrix

pub fn apply_to_canvas(&self, canvas: &Canvas) -> &Self

pub fn dot_with_normal(&self, d: impl Into<V3>) -> scalar

Trait Implementations

impl<N: NativeDrop> Drop for RefHandle<N>

fn drop(&mut self)

Executes the destructor for this type.

impl<N: NativeDrop + NativePartialEq> PartialEq for RefHandle<N>

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> PointerWrapper<N> for RefHandle<N>

where N: NativeDrop,

fn wrap(ptr: *mut N) -> Option<Self>

Wraps a native pointer into a wrapper type. Returns None if the pointer is null.

fn unwrap(self) -> *mut N

Unwraps the wrapper type into the native pointer.

fn inner(&self) -> &N

Access the wrapped pointer.

fn inner_mut(&mut self) -> &mut N

Access the wrapped pointer.

impl<T> RunIterator for RefHandle<T>

where T: NativeDrop + NativeBase<SkShaper_RunIterator>,

fn consume(&mut self)

fn end_of_current_run(&self) -> usize

fn at_end(&self) -> bool