Skip to main content

GlTextureHandle

Struct GlTextureHandle 

Source
pub struct GlTextureHandle { /* private fields */ }
Expand description

GL texture name (GLuint) + binding metadata.

Implementations§

Source§

impl GlTextureHandle

Source

pub unsafe fn try_from_raw( name: u32, target: GlTextureTarget, format: GlInternalFormat, context: *mut c_void, share_group: Option<u64>, keep_alive: Option<KeepAlive>, ) -> Result<Self, InvalidHandleError>

Wrap a GL texture name plus its binding metadata. Borrowing: the handle is stored non-owningly, this type has no Drop, and every obligation below extends to each Clone.

§Safety
  • name must be a texture name that is live in context’s share group — allocated by glGenTextures/glCreateTextures and not yet deleted. GL names are small integers, so an arbitrary u32 is not distinguishable from a real one at the API boundary and will silently address whatever texture the driver later assigns that name. name == 0 is rejected as InvalidHandleError::NullHandle and is not a caller obligation.
  • target and format must be the texture’s actual binding target and sized internal format. Consumers bind with target and interpret texels by format; a mismatched target is a GL error, a mismatched format misreads the texel data.
  • context == null means “whatever context is current on the consuming thread”. That is sound only in a single-context process, or when the caller has independently guaranteed the consumer runs on a thread with a context in the right share group. Otherwise pass the real context handle.
  • share_group, when Some, must identify the share group name belongs to; importers use it to refuse names from an unrelated group.
  • Thread affinity — this is the sharp edge. GL contexts are current on at most one thread at a time and texture names are only meaningful to a thread whose current context is in the same share group. GlTextureHandle is nevertheless Send + Sync, because the handle is inert data; the caller asserts that whichever thread ultimately touches it has an appropriate context current, and that the producer is not concurrently issuing GL commands against the same name from another.
  • Lifetime: nothing is retained and there is no Drop, so glDeleteTextures must not run while this value or any Clone of it is reachable. Pass a keep_alive anchor to discharge that; with None the caller carries it.
Source

pub fn name(&self) -> u32

Source

pub fn target(&self) -> GlTextureTarget

Source

pub fn format(&self) -> GlInternalFormat

Source

pub fn context(&self) -> *mut c_void

Source

pub fn share_group(&self) -> Option<u64>

Source

pub fn keep_alive(&self) -> Option<&KeepAlive>

Trait Implementations§

Source§

impl Clone for GlTextureHandle

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 Debug for GlTextureHandle

Source§

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

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

impl Send for GlTextureHandle

Source§

impl Sync for GlTextureHandle

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<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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

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,