Skip to main content

SceneTextureId

Struct SceneTextureId 

Source
pub struct SceneTextureId(/* private fields */);
Expand description

A process-unique id Texture::as_scene_texture mints once per Texture and shares across Clone — the TextureRegistry key Command::SceneTexture resolves against.

Mirrors frust_scene::ShaderProgram::id: minted fresh only at construction (never re-minted on Clone), off a process-wide AtomicU64 so two distinct textures never collide even when built on different threads.

Implementations§

Source§

impl SceneTextureId

Source

pub fn mint() -> Self

Mints a fresh, process-unique id.

Texture::new mints one per texture and shares it across Clone, and that stays the ordinary route. This is public for the caller that has no Texture to mint from: a texture rendered externally — one whose wgpu::TextureView its owner creates, re-creates and binds itself every frame — still needs one stable id to be named by across those re-creations, and minting here is what hands it one out of the same process-wide counter. The shader-program id space stays reserved against every such mint by construction (see Self::for_shader_program).

Source

pub const fn for_shader_program(program_id: u64) -> Self

The id under which the offscreen target of the fragment program program_id is registered.

Derived from the program’s own ordinal rather than minted, because both halves of the seam have to name the same texture while holding different things: the pre-pass that renders the program has the target, and the display-list walk that draws it has only frust_scene::ShaderProgram::id. A pure function of the program id lets each compute the id the other used, with no shared side table to keep in step.

Disjoint from Self::mint’s range by construction — see [SHADER_PROGRAM_NAMESPACE] — so a host texture and a shader target can never answer to the same id. A program_id large enough to reach the reserved bit itself is impossible for the same counting reason its minter is.

Source

pub const fn get(self) -> u64

The opaque value this id wraps.

The counterpart of frust_scene::ShaderProgram::id, and for the same reason: the scene layer carries an externally owned texture as a plain u64 so it depends on no GPU crate, and a caller that registered a Texture needs some way to say which one a display-list command means. This only reads back what Self::mint handed out; it never mints.

Source

pub const fn is_shader_program(self) -> bool

Whether self carries the bit Self::for_shader_program sets — i.e. whether it names a shader program’s own offscreen target rather than something an ordinary caller minted.

Lets a caller outside this module test which namespace an id belongs to without the reserved bit itself being exported — a check on the id stays valid even if the bit’s exact value ever changed.

Trait Implementations§

Source§

impl Clone for SceneTextureId

Source§

fn clone(&self) -> Self

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

impl Copy for SceneTextureId

Source§

impl Debug for SceneTextureId

Source§

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

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

impl Eq for SceneTextureId

Source§

impl Hash for SceneTextureId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SceneTextureId

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SceneTextureId

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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

Source§

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

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

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

Source§

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

Compare self to key and return true if they are equal.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

Source§

impl<T> WasmNotSendSync for T

Source§

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