FGenericPlatformMemory::FSharedMemoryRegion Struct Reference

#include <GenericPlatformMemory.h>

Inheritance diagram for FGenericPlatformMemory::FSharedMemoryRegion:

Public Member Functions
const TCHAR *	GetName () const
void *	GetAddress ()
const void *	GetAddress () const
SIZE_T	GetSize () const
	FSharedMemoryRegion (const FString &InName, uint32 InAccessMode, void *InAddress, SIZE_T InSize)

Protected Types
enum	Limits { MaxSharedMemoryName = 128 }

Protected Attributes
TCHAR	Name [MaxSharedMemoryName]
uint32	AccessMode
void *	Address
SIZE_T	Size

Detailed Description

Generic representation of a shared memory region

Member Enumeration Documentation

Limits

enum FGenericPlatformMemory::FSharedMemoryRegion::Limits

protected

Enumerator
MaxSharedMemoryName

Constructor & Destructor Documentation

FSharedMemoryRegion()

FGenericPlatformMemory::FSharedMemoryRegion::FSharedMemoryRegion	(	const FString &	InName,
		uint32	InAccessMode,
		void *	InAddress,
		SIZE_T	InSize
	)

Member Function Documentation

GetAddress() [1/2]

void * FGenericPlatformMemory::FSharedMemoryRegion::GetAddress ( )

inline

Returns the beginning of the region in process address space

GetAddress() [2/2]

const void * FGenericPlatformMemory::FSharedMemoryRegion::GetAddress ( ) const

inline

Returns the beginning of the region in process address space

GetName()

const TCHAR * FGenericPlatformMemory::FSharedMemoryRegion::GetName ( ) const

inline

Returns the name of the region

GetSize()

SIZE_T FGenericPlatformMemory::FSharedMemoryRegion::GetSize ( ) const

inline

Returns size of the region in bytes

Member Data Documentation

AccessMode

uint32 FGenericPlatformMemory::FSharedMemoryRegion::AccessMode

protected

Access mode for the region

Address

void* FGenericPlatformMemory::FSharedMemoryRegion::Address

protected

The actual buffer

Name

TCHAR FGenericPlatformMemory::FSharedMemoryRegion::Name[MaxSharedMemoryName]

protected

Name of the region

Size

SIZE_T FGenericPlatformMemory::FSharedMemoryRegion::Size

protected

Size of the buffer

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMemory.h
• Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformMemory.cpp