Struct SubTexture

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

Implementations

impl SubTexture

pub fn new<P: IsA<Texture>>( ctx: &Context, parent_texture: &P, sub_x: i32, sub_y: i32, sub_width: i32, sub_height: i32, ) -> SubTexture

Creates a high-level SubTexture representing a sub-region of any other Texture. The sub-region must strictly lye within the bounds of the parent_texture. The returned texture implements the MetaTexture interface because it’s not a low level texture that hardware can understand natively.

<note>Remember: Unless you are using high level drawing APIs such as cogl_rectangle or other APIs documented to understand the MetaTexture interface then you need to use the MetaTexture interface to resolve a SubTexture into a low-level texture before drawing.</note>

ctx

A Context pointer

parent_texture

The full texture containing a sub-region you want to make a SubTexture from.

sub_x

The top-left x coordinate of the parent region to make a texture from.

sub_y

The top-left y coordinate of the parent region to make a texture from.

sub_width

The width of the parent region to make a texture from.

sub_height

The height of the parent region to make a texture from.

Returns

A newly allocated SubTexture representing a sub-region of parent_texture.

pub fn get_parent(&self) -> Option<Texture>

Retrieves the parent texture that self derives its content from. This is the texture that was passed to SubTexture::new as the parent_texture argument.

Returns

The parent texture that self derives its content from.

Trait Implementations

impl Clone for SubTexture

fn clone(&self) -> SubTexture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubTexture

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

Formats the value using the given formatter.

impl Display for SubTexture

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

Formats the value using the given formatter.

impl Hash for SubTexture

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

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 SubTexture

fn cmp(&self, other: &SubTexture) -> 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<T: ObjectType> PartialEq<T> for SubTexture

fn eq(&self, other: &T) -> 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<T: ObjectType> PartialOrd<T> for SubTexture

fn partial_cmp(&self, other: &T) -> 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 SubTexture

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SubTexture

impl IsA<Object> for SubTexture