Struct dx::platform::core::SubTexture

pub struct SubTexture {}

Implementations

impl SubTexture

pub fn new<P: Is<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.

Remember: Unless you are using high level drawing APIs such as 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.

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 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 Display for SubTexture

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

Formats the value using the given formatter.