Interface Image

interface Image
  : ImageBase
  , IAtomicRefCounted ;

Properties

NameTypeDescription
boundMemory[get] DeviceMemoryThe memory bound to this image
device[get] DeviceGet the parent device
memoryRequirements[get] MemoryRequirements
info[get] ImageInfo
refCount[get] ulongAtomically loads the number of active references.
refCountShared[get] ulongAtomically loads the number of active references.

Methods

NameDescription
bindMemory (mem, offset) The image keeps a reference of the device memory
createView (viewtype, isr, swizzle)
dispose () Dispose the underlying resource
rcLock () Returns whether the refCount >= 1. This increases the refCount by 1. rcLock should be used to keep weak reference and ensures that the resource is not disposed. The operation is atomic.
rcLockShared () Returns whether the refCount >= 1. This increases the refCount by 1. rcLock should be used to keep weak reference and ensures that the resource is not disposed. The operation is atomic.
release (disposeOnZero) Atomically decrement the reference count. If refCount reaches zero, and disposeOnZero is set, the object is locked with its own mutex, and dispose is called. In most cases, the calling code should set disposeOnZero, unless it is intended to release the object to give it away. (such as at the end of a builder function)
releaseShared (disposeOnZero) Atomically decrement the reference count. If refCount reaches zero, and disposeOnZero is set, the object is locked with its own mutex, and dispose is called. In most cases, the calling code should set disposeOnZero, unless it is intended to release the object to give it away. (such as at the end of a builder function)
retain () Atomically increment the reference count.
retainShared () Atomically increment the reference count.