CVB.Net 15.0
Loading...
Searching...
No Matches
CompressedPfncBuffer Class Referencesealed

PFNC buffer class implementing a compressed pfnc buffer. More...

Inherits PfncBuffer, and ICompressedPfncBuffer.

Static Public Member Functions

static new CompressedPfncBuffer FromHandle (IntPtr handle, ShareObject doShare)
 Creates a new instance of CompressedPfncBuffer from the specified handle.
 
- Static Public Member Functions inherited from PfncBuffer
static new PfncBuffer FromHandle (IntPtr handle, ShareObject doShare)
 Create a buffer object from a handle .
 
- Static Public Member Functions inherited from Buffer
static Buffer FromHandle (IntPtr handle, ShareObject doShare)
 Create a buffer object from a handle .
 

Properties

CompressionType CompressionType [get]
 The CompressionType used to compress this buffer.
 
- Properties inherited from PfncBuffer
PfncFormat PfncFormat [get]
 Get the PFNC format of the pixel data stored in this buffer.
 
int Rank [get]
 Get the rank of the plane.
 
- Properties inherited from Buffer
IntPtr Handle [get]
 Native CVB buffer handle.
 
bool IsDisposed [get]
 Tests if the native handle has already been disposed.
 
IntPtr BasePtr [get]
 Get the base address of the buffer's memory.
 
long Size [get]
 Get the valid size in bytes of the buffer's memory.
 
long Capacity [get]
 Get the allocated size in bytes of the buffer's memory.
 

Additional Inherited Members

- Public Member Functions inherited from PfncBuffer
IntPtr GetIncrement (int dimension)
 Gets the number of elements at the given dimension .
 
long GetLength (int dimension)
 Gets the number of elements at the given dimension .
 
- Public Member Functions inherited from Buffer
void Dispose ()
 IDisposable implementation.
 
- Protected Member Functions inherited from PfncBuffer
 PfncBuffer (IntPtr handle)
 Create a buffer object from a handle .
 
- Protected Member Functions inherited from Buffer
 Buffer (IntPtr handle)
 Create a buffer object from a handle .
 
virtual void Dispose (bool disposing)
 IDispose helper function.
 
- Events inherited from Buffer
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
 

Detailed Description

PFNC buffer class implementing a compressed pfnc buffer.

Member Function Documentation

◆ FromHandle()

static new CompressedPfncBuffer FromHandle ( IntPtr handle,
ShareObject doShare )
static

Creates a new instance of CompressedPfncBuffer from the specified handle.

Parameters
handleNative ICompressedPfncBuffer handle.
doShareSpecifies whether the handle should be shared. Use ShareObject.Yes to share the handle, or ShareObject.No to avoid sharing.
Returns
A new instance of CompressedPfncBuffer associated with the specified handle.