Skip to content

LiteFX::Rendering::IDeviceMemory

Describes a chunk of device memory.

Synopsis

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] IDeviceMemory;

Types

NameDescription
PrepareMoveEventArgs Stores a reference to a barrier that can be used to synchronize accesses to the resource with a move operation.
ResourceMovingEventArgs Stores the fence and the command queue to wait on for the fence before a moved resource can be used.

Member Functions

NameDescription
~IDeviceMemory [destructor] [virtual]Destructor
alignedElementSize [virtual]Returns the actual size of the element in device memory.
elementAlignment [virtual]Returns the alignment of a single element.
elementSize [virtual]Returns the size of a single element within the buffer. If there is only one element, this is equal to size.
elements [virtual]Gets the number of sub-resources inside the memory chunk.
size [virtual]Gets the size (in bytes) of the aligned memory chunk.
usage [virtual]Returns the usage flags for the resource.
virtualAddress [virtual]Gets the address of the resource in GPU memory.
volatileMove [virtual]Returns true, if the contents of the resource should not be copied during a move.
writable [virtual]Returns true, if the resource can be bound to a read/write descriptor.

Data Members

NameDescription
moved An event that gets invoked, after the resource has been moved to a different location, but before the old resource gets destroyed.
moving An event that gets invoked before a resource is copied during a move.
prepareMove An event that gets invoked to prepare a resource for a move operation.

Protected Member Functions

NameDescription
IDeviceMemory [constructor]Constructors
operator= Assignment operators

Derived Classes

NameDescription
IBuffer Base interface for buffer objects.
IImage Describes a generic image.