This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Memory Class

Header: #include <UnigineMemory.h>

This class controls memory allocations.

Memory Class

Members

int getFrameAllocations() const#

Returns the current number of allocations made per frame.

Return value

Current number of allocations.

int getMaxAllocations() const#

Returns the current maximum number of allocations made during runtime (peak consumption).

Return value

Current number of allocations.

int getLiveAllocations() const#

Returns the current number of allocations made.

Return value

Current number of allocations.

size_t getInstancePoolUsage() const#

Returns the current amount of memory allocated in instance pools. The instance pools store allocations defined by developers. Usually, these are the allocations which are required regularly. They work the same way as the dynamic pools, but the instance pools have no size limitation.

Return value

Current amount of memory.

size_t getDynamicPoolUsage() const#

Returns the current amount of memory allocated in dynamic pools (available on Windows only).

Return value

Current amount of memory.

size_t getStaticPoolUsage() const#

Returns the current amount of memory allocated in static pools.

Return value

Current amount of memory.

bool isStatisticsEnabled() const#

Returns the current value indicating whether gathering memory statistics required for pool configuration is enabled.

Return value

true if is enabled; otherwise false.

size_t getMemoryUsage() const#

Returns the current Shows the overall amount of used memory in bytes.

Return value

Current Used memory in bytes.

int isInitialized ( ) #

Returns the status of the memory manager.

Return value

1 if the memory manager is initialized; otherwise, 0.

static void allocate ( size_t size ) #

Allocates the dynamic memory.

Arguments

  • size_t size - Size of the allocated memory block.

static int deallocate ( void * ptr ) #

Deallocates the dynamic memory.

Arguments

  • void * ptr - Pointer to the allocated memory block.

static void deallocate ( void * ptr, size_t size ) #

Deallocates the dynamic memory.

Arguments

  • void * ptr - Pointer to the allocated memory block.
  • size_t size - Size of the allocated memory block.

size_t getMemoryUsage ( ) #

Shows the overall amount of used memory in bytes.

Return value

Used memory in bytes.

static void logInfo ( ) #

Prints information on small allocations in the static and dynamic memory pools.
Last update: 2024-12-13
Build: ()