Struct Tex

Source
pub struct Tex<S, F, T: TexType> {
    pub param: TexParam,
    /* private fields */
}

Fields§

§param: TexParam

Implementations§

Source§

impl<S, F, T: TexType> Tex<S, F, T>

Source

pub fn obj(&self) -> u32

Source

pub fn Save<RS: TexSize, RF: TexFmt>(&self, lvl: u32) -> Box<[RF]>

Source

pub fn Bind<'l>(&'l self, samp: &'l Sampler) -> TextureBinding<'_, T>

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_1D>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs1<F>) -> Self
where i32: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs1<F>) -> Self
where i32: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where i32: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs1<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs1<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_2D>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs2<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs2<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec2: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs2<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs2<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_3D>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec3: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs3<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs3<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_1D_ARRAY>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs2<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs2<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec2: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs2<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs2<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_2D_ARRAY>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec3: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs3<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs3<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_CUBE_MAP>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec2: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec2: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs3<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs3<RF>>( &mut self, args: T, )

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_CUBE_MAP_ARRAY>

Source

pub fn new<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_mips<D>(dimensions: D, args_u: impl UpdArgs3<F>) -> Self
where iVec3: Cast<D>,

Source

pub fn new_empty<D, M>(dim: D, mip_levels: M) -> Self
where iVec3: Cast<D>, i16: Cast<M>,

Source

pub fn Update(&mut self, args: impl UpdArgs3<F>)

Source

pub fn UpdateCustom<RS: TexSize, RF: TexFmt, T: UpdArgs3<RF>>( &mut self, args: T, )

Source§

impl<S, F> Tex<S, F, GL_TEXTURE_2D>

Source

pub fn Cast<RS: TexSize, RF: TexFmt>(&self, minification: i32) -> Tex2d<RS, RF>

Source§

impl<S: TexSize, F: TexFmt> Tex<S, F, GL_TEXTURE_2D>

Source

pub fn from_type<RS: TexSize, RF: TexFmt>(img: &Image<RS, RF>) -> Self

Trait Implementations§

Source§

impl<S: Debug, F: Debug, T: Debug + TexType> Debug for Tex<S, F, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Default, F: Default, T: Default + TexType> Default for Tex<S, F, T>

Source§

fn default() -> Tex<S, F, T>

Returns the “default value” for a type. Read more
Source§

impl<S: TexSize, F: TexFmt, RS, RF> From<&Tex<RS, RF, GL_TEXTURE_2D>> for Image<S, F>

Source§

fn from(tex: &Tex2d<RS, RF>) -> Self

Converts to this type from the input type.
Source§

impl<S: TexSize, F: TexFmt, RS, RF> From<Tex<RS, RF, GL_TEXTURE_2D>> for Image<S, F>

Source§

fn from(tex: Tex2d<RS, RF>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<S, F, T> !Freeze for Tex<S, F, T>

§

impl<S, F, T> !RefUnwindSafe for Tex<S, F, T>

§

impl<S, F, T> Send for Tex<S, F, T>
where S: Send, F: Send, T: Send,

§

impl<S, F, T> !Sync for Tex<S, F, T>

§

impl<S, F, T> Unpin for Tex<S, F, T>
where S: Unpin, F: Unpin, T: Unpin,

§

impl<S, F, T> UnwindSafe for Tex<S, F, T>
where S: UnwindSafe, F: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OrAssignment for T
where T: Default,

Source§

fn or_def(self, filter: bool) -> T

Source§

fn or_val(self, filter: bool, v: T) -> T

Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SendStat for T
where T: 'static + Send,