.TH "include/Zycore/API/Memory.h" 3 "Version 1.5.0.0" "Zycore" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/Zycore/API/Memory.h
.SH SYNOPSIS
.br
.PP
\fC#include <Zycore/Defines\&.h>\fP
.br
\fC#include <Zycore/Status\&.h>\fP
.br
\fC#include <Zycore/Types\&.h>\fP
.br

.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef enum \fBZyanMemoryPageProtection_\fP \fBZyanMemoryPageProtection\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBZyanMemoryPageProtection_\fP "
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBZYCORE_EXPORT\fP ZyanU32 \fBZyanMemoryGetSystemPageSize\fP (void)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP ZyanU32 \fBZyanMemoryGetSystemAllocationGranularity\fP (void)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanMemoryVirtualProtect\fP (void *address, ZyanUSize size, \fBZyanMemoryPageProtection\fP protection)"
.br
.ti -1c
.RI "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP \fBZyanMemoryVirtualFree\fP (void *address, ZyanUSize size)"
.br
.in -1c
.SH "Typedef Documentation"
.PP 
.SS "typedef enum \fBZyanMemoryPageProtection_\fP \fBZyanMemoryPageProtection\fP"
Defines the \fCZyanMemoryPageProtection\fP enum\&. 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBZyanMemoryPageProtection_\fP"
Defines the \fCZyanMemoryPageProtection\fP enum\&. 
.SH "Function Documentation"
.PP 
.SS "\fBZYCORE_EXPORT\fP ZyanU32 ZyanMemoryGetSystemAllocationGranularity (void)"
Returns the system allocation granularity\&.
.PP
The system allocation granularity specifies the minimum amount of bytes which can be allocated at a specific address by a single call of \fCZyanMemoryVirtualAlloc\fP\&.
.PP
This value is typically 64KiB on Windows systems and equal to the page size on most POSIX platforms\&.
.PP
\fBReturns\fP
.RS 4
The system allocation granularity\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP ZyanU32 ZyanMemoryGetSystemPageSize (void)"
Returns the system page size\&.
.PP
\fBReturns\fP
.RS 4
The system page size\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanMemoryVirtualFree (void * address, ZyanUSize size)"
Releases one or more memory pages starting at the given address\&.
.PP
\fBParameters\fP
.RS 4
\fIaddress\fP The start address aligned to a page boundary\&. 
.br
\fIsize\fP The size\&.
.RE
.PP
\fBReturns\fP
.RS 4
A zyan status code\&. 
.RE
.PP

.SS "\fBZYCORE_EXPORT\fP \fBZyanStatus\fP ZyanMemoryVirtualProtect (void * address, ZyanUSize size, \fBZyanMemoryPageProtection\fP protection)"
Changes the memory protection value of one or more pages\&.
.PP
\fBParameters\fP
.RS 4
\fIaddress\fP The start address aligned to a page boundary\&. 
.br
\fIsize\fP The size\&. 
.br
\fIprotection\fP The new page protection value\&.
.RE
.PP
\fBReturns\fP
.RS 4
A zyan status code\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Zycore from the source code\&.