Interface IGorgonSharedResource

Provides the ability return a shared resource for passing objects to other APIs.

public interface IGorgonSharedResource : IGorgonNativeResource

| Edit this page View Source

Function to acquire the mutex for the texture.

void Acquire(long key, int timeOut)

Type	Name	Description
long	key	The key to use for the mutex.
int	timeOut	The number of milliseconds that the mutex should last for. Use MaxValue for an indefinite timeout.

Calls to this method must be matched with a call to Release(long) to avoid issues with leakage.

This method will only work with textures that have a value of SharedKeyedMutex assigned to Shared.

| Edit this page View Source

Function to retrieve the shared resource handle for this resource.

nint GetSharedHandle()

Type	Description
nint	A pointer representing a handle for sharing the resource data with other interfaces.

This is used to retrieve a handle to the shared resource that allows applications to share the resource with other APIs (e.g. Direct 2D).

This method will only work with textures that have a value of SharedKeyedMutex, or Shared assigned to Shared.

| Edit this page View Source

Function to release a previously acquired mutex for the texture.

void Release(long key)

Type	Name	Description
long	key	The key used for the mutex.

This method must be called when a call to Acquire(long, int) is made, and the mutex is no longer required.

This method will only work with textures that have a value of SharedKeyedMutex assigned to Shared.