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

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBZYCORE_VERSION\fP   (ZyanU64)0x0001000500000000"
.br
.ti -1c
.RI "#define \fBZYCORE_VERSION_MAJOR\fP(version)   (ZyanU16)((version & 0xFFFF000000000000) >> 48)"
.br
.ti -1c
.RI "#define \fBZYCORE_VERSION_MINOR\fP(version)   (ZyanU16)((version & 0x0000FFFF00000000) >> 32)"
.br
.ti -1c
.RI "#define \fBZYCORE_VERSION_PATCH\fP(version)   (ZyanU16)((version & 0x00000000FFFF0000) >> 16)"
.br
.ti -1c
.RI "#define \fBZYCORE_VERSION_BUILD\fP(version)   (ZyanU16)(version & 0x000000000000FFFF)"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBZYCORE_EXPORT\fP ZyanU64 \fBZycoreGetVersion\fP (void)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Master include file, including everything else\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define ZYCORE_VERSION   (ZyanU64)0x0001000500000000"
A macro that defines the zycore version\&. 
.SS "#define ZYCORE_VERSION_BUILD(version)   (ZyanU16)(version & 0x000000000000FFFF)"
Extracts the build-part of the zycore version\&.
.PP
\fBParameters\fP
.RS 4
\fIversion\fP The zycore version value 
.RE
.PP

.SS "#define ZYCORE_VERSION_MAJOR(version)   (ZyanU16)((version & 0xFFFF000000000000) >> 48)"
Extracts the major-part of the zycore version\&.
.PP
\fBParameters\fP
.RS 4
\fIversion\fP The zycore version value 
.RE
.PP

.SS "#define ZYCORE_VERSION_MINOR(version)   (ZyanU16)((version & 0x0000FFFF00000000) >> 32)"
Extracts the minor-part of the zycore version\&.
.PP
\fBParameters\fP
.RS 4
\fIversion\fP The zycore version value 
.RE
.PP

.SS "#define ZYCORE_VERSION_PATCH(version)   (ZyanU16)((version & 0x00000000FFFF0000) >> 16)"
Extracts the patch-part of the zycore version\&.
.PP
\fBParameters\fP
.RS 4
\fIversion\fP The zycore version value 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "\fBZYCORE_EXPORT\fP ZyanU64 ZycoreGetVersion (void)"
Returns the zycore version\&.
.PP
\fBReturns\fP
.RS 4
The zycore version\&.
.RE
.PP
Use the macros provided in this file to extract the major, minor, patch and build part from the returned version value\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for Zycore from the source code\&.