Skip to main content

SharedTexture

Struct SharedTexture 

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

A shared BGRA8 or half-float texture opened on the renderer’s device, from another device, API or process. On Windows: D3D11, D3D12, or Vulkan rendering into D3D12 memory it imports. On macOS: an IOSurface from another MTLDevice, process or framework. Reopen it after SurfaceError::DeviceChanged.

Implementations§

Source§

impl SharedTexture

Source

pub fn open(handle: u64) -> Result<SharedTexture, SurfaceError>

Opens a handle this process holds: an NT handle (CreateSharedHandle in D3D11 or D3D12) or a legacy one (IDXGIResource::GetSharedHandle). The handle stays the caller’s to close.

Source

pub fn open_from_process( pid: u32, handle: u64, ) -> Result<SharedTexture, SurfaceError>

Duplicates the NT handle handle of process pid into this process and opens it. Needs PROCESS_DUP_HANDLE on that process, which a child or a same-user process grants.

Source

pub unsafe fn from_iosurface( surface: *mut c_void, ) -> Result<SharedTexture, SurfaceError>

Opens an IOSurfaceRef this process holds (macOS): pixel format 'BGRA' (or 'RGhA'), made by any MTLDevice or framework. It is retained while this lives.

§Safety

surface is null or a live IOSurfaceRef.

Source

pub fn from_mach_port(port: u32) -> Result<SharedTexture, SurfaceError>

Opens the IOSurface another process sent as a mach port (IOSurfaceCreateMachPort), a send right this process holds and stays the caller’s to deallocate.

Source

pub fn with_keyed_mutex(self, acquire: u64, release: u64) -> SharedTexture

Synchronises through the texture’s IDXGIKeyedMutex: each present acquires acquire and releases release. Required for a texture made with SHARED_KEYEDMUTEX. Windows only; on macOS a present of it fails with SurfaceError::NotSupported.

Source

pub fn with_fence(self, fence: u64) -> Result<SharedTexture, SurfaceError>

Synchronises through a shared fence, an NT handle this process holds: a D3D12 fence made D3D12_FENCE_FLAG_SHARED, an ID3D11Fence made D3D11_FENCE_FLAG_SHARED, or a Vulkan semaphore exported as D3D12_FENCE. Present it with SurfaceHandle::present_shared_fenced. The handle stays the caller’s to close.

Source

pub fn with_fence_from_process( self, pid: u32, fence: u64, ) -> Result<SharedTexture, SurfaceError>

Self::with_fence for a fence handle of process pid.

Source

pub unsafe fn with_shared_event( self, event: *mut c_void, ) -> Result<SharedTexture, SurfaceError>

Synchronises through an id<MTLSharedEvent> of this process (macOS), from any device: present it with SurfaceHandle::present_shared_fenced. It is retained while this lives.

§Safety

event is null or a live id<MTLSharedEvent>.

Source

pub unsafe fn with_shared_event_handle( self, handle: *mut c_void, ) -> Result<SharedTexture, SurfaceError>

Self::with_shared_event for an event of another process: the MTLSharedEventHandle it made (newSharedEventHandle) and sent over XPC.

§Safety

handle is null or a live MTLSharedEventHandle.

Source

pub fn with_timeout(self, timeout: Duration) -> SharedTexture

How long a present waits for the acquire key, or (under the D3D11 renderer) for the fence; 100 ms by default. Under the D3D12 renderer and on macOS the GPU waits instead.

Source

pub fn size(&self) -> (u32, u32)

Source

pub fn format(&self) -> SurfaceFormat

The texture’s pixels, which the surface it is presented to must be set to.

Trait Implementations§

Source§

impl Debug for SharedTexture

Source§

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

Formats the value using the given formatter. Read more

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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> Upcast<T> for T

Source§

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

Source§

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

Source§

fn vzip(self) -> V

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

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

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

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