Skip to main content

Ktx2Document

Struct Ktx2Document 

pub struct Ktx2Document<'a> {
    pub vk_format: u32,
    pub type_size: u32,
    pub pixel_width: u32,
    pub pixel_height: u32,
    pub pixel_depth: u32,
    pub layer_count_field: u32,
    pub face_count: u32,
    pub level_count_field: u32,
    pub supercompression_scheme: u32,
    /* private fields */
}
Expand description

A borrowed KTX2 container. Every exposed section has passed checked bounds and overlap tests.

Fields§

§vk_format: u32§type_size: u32§pixel_width: u32§pixel_height: u32

Zero means a 1D texture, per KTX2.

§pixel_depth: u32

Zero means a 1D/2D texture, per KTX2.

§layer_count_field: u32

Zero in the header means a non-array texture; layer_count() reports its effective count.

§face_count: u32§level_count_field: u32

Zero in the header means one level with no mip chain; level_count() is the effective count.

§supercompression_scheme: u32

Implementations§

§

impl<'a> Ktx2Document<'a>

pub fn parse(bytes: &'a [u8]) -> Result<Ktx2Document<'a>, Ktx2Error>

Validate a KTX2 header, metadata ranges, and level index without allocating.

pub const fn layer_count(&self) -> u32

Effective array layer count; non-array textures have one layer.

pub const fn level_count(&self) -> usize

Effective number of indexed levels; a zero header field represents a single base level.

pub const fn supercompression(&self) -> Ktx2Supercompression

Ktx2Document::supercompression.

pub const fn transcode_source(&self) -> Option<Ktx2TranscodeSource>

Return a typed transcode requirement for Basis or known GPU block formats.

The parser deliberately does not infer a target GPU format. HMC/device policy must choose that target and keep the encoded resource available while refinement is pending.

pub const fn color_space(&self) -> Ktx2ColorSpace

Ktx2Document::color_space.

pub fn data_format_descriptor(&self) -> &'a [u8] ⓘ

Borrow the Data Format Descriptor bytes. The descriptor’s internal contents are opaque.

pub fn key_value_data(&self) -> &'a [u8] ⓘ

Borrow the Key/Value Data bytes. Entries are intentionally not decoded here.

pub fn supercompression_global_data(&self) -> &'a [u8] ⓘ

Borrow the Supercompression Global Data bytes, if present.

pub fn level(&self, index: usize) -> Option<Ktx2Level<'a>>

Borrow one encoded level and report its declared uncompressed length.

Trait Implementations§

§

impl<'a> Clone for Ktx2Document<'a>

§

fn clone(&self) -> Ktx2Document<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl<'a> Copy for Ktx2Document<'a>

§

impl<'a> Debug for Ktx2Document<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> Eq for Ktx2Document<'a>

§

impl<'a> PartialEq for Ktx2Document<'a>

§

fn eq(&self, other: &Ktx2Document<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl<'a> StructuralPartialEq for Ktx2Document<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Ktx2Document<'a>

§

impl<'a> RefUnwindSafe for Ktx2Document<'a>

§

impl<'a> Send for Ktx2Document<'a>

§

impl<'a> Sync for Ktx2Document<'a>

§

impl<'a> Unpin for Ktx2Document<'a>

§

impl<'a> UnsafeUnpin for Ktx2Document<'a>

§

impl<'a> UnwindSafe for Ktx2Document<'a>

Blanket Implementations§

§

impl<S, A> Aggregate<Result<S, Error>> for A
where A: Aggregate<S>,

§

fn from_shares<T>(iter: T) -> Result<A, Error>
where T: IntoIterator<Item = Result<S, Error>>,

Aggregate shares in an MPC protocol.
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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more