Click or drag to resize
Ab4d.SharpEngine logo

SceneGetFullMemoryUsageInfo Method

Returns a string that shows full memory usage for this Scene, its GpuDevice and all used effects.

Namespace: Ab4d.SharpEngine
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.2.9386+3a404a3e1ebfa4efd231da7fe6f10dfb23b95dc4
Syntax
C#
public string GetFullMemoryUsageInfo(
	bool dumpAllActiveAllocations = true,
	bool dumpBlockUsageTable = true,
	bool listIndividualAllocations = true,
	bool showSceneCachedObjects = true,
	bool showDeviceCachedObjects = true,
	bool showMemoryBudget = true,
	bool showMemoryTypes = true,
	bool showCachedDescriptorSets = true
)

Parameters

dumpAllActiveAllocations  Boolean  (Optional)
when true (by default) then details for all active allocations are added to the report string
dumpBlockUsageTable  Boolean  (Optional)
when true (by default) then a map of block usage is shown with stars and dots showing used and free areas of the memory block
listIndividualAllocations  Boolean  (Optional)
when true (by default) then individual allocations are listed
showSceneCachedObjects  Boolean  (Optional)
when true (by default) then objects that are cached by this Scene are shown
showDeviceCachedObjects  Boolean  (Optional)
when true (by default) then objects that are cached by the GpuDevice are shown
showMemoryBudget  Boolean  (Optional)
when true (by default) then memory heap usage and available budget is shown (when that data is available)
showMemoryTypes  Boolean  (Optional)
when true (by default) then available memory types are shown
showCachedDescriptorSets  Boolean  (Optional)
when true (by default) then cached descriptor sets are shown

Return Value

String
string that shows full memory usage
Remarks

[Missing <remarks> documentation for "M:Ab4d.SharpEngine.Scene.GetFullMemoryUsageInfo(System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean)"]

See Also