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

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBZYAN_INT8_MIN\fP   INT8_MIN"
.br
.ti -1c
.RI "#define \fBZYAN_INT16_MIN\fP   INT16_MIN"
.br
.ti -1c
.RI "#define \fBZYAN_INT32_MIN\fP   INT32_MIN"
.br
.ti -1c
.RI "#define \fBZYAN_INT64_MIN\fP   INT64_MIN"
.br
.ti -1c
.RI "#define \fBZYAN_INT8_MAX\fP   INT8_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_INT16_MAX\fP   INT16_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_INT32_MAX\fP   INT32_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_INT64_MAX\fP   INT64_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_UINT8_MAX\fP   UINT8_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_UINT16_MAX\fP   UINT16_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_UINT32_MAX\fP   UINT32_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_UINT64_MAX\fP   UINT64_MAX"
.br
.ti -1c
.RI "#define \fBZYAN_NULL\fP   ((void*)0)"
.br
.ti -1c
.RI "#define \fBZYAN_FALSE\fP   0u"
.br
.ti -1c
.RI "#define \fBZYAN_TRUE\fP   1u"
.br
.ti -1c
.RI "#define \fBZYAN_TERNARY_FALSE\fP   (\-1)"
.br
.ti -1c
.RI "#define \fBZYAN_TERNARY_UNKNOWN\fP   0x00"
.br
.ti -1c
.RI "#define \fBZYAN_TERNARY_TRUE\fP   0x01"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef uint8_t \fBZyanU8\fP"
.br
.ti -1c
.RI "typedef uint16_t \fBZyanU16\fP"
.br
.ti -1c
.RI "typedef uint32_t \fBZyanU32\fP"
.br
.ti -1c
.RI "typedef uint64_t \fBZyanU64\fP"
.br
.ti -1c
.RI "typedef int8_t \fBZyanI8\fP"
.br
.ti -1c
.RI "typedef int16_t \fBZyanI16\fP"
.br
.ti -1c
.RI "typedef int32_t \fBZyanI32\fP"
.br
.ti -1c
.RI "typedef int64_t \fBZyanI64\fP"
.br
.ti -1c
.RI "typedef size_t \fBZyanUSize\fP"
.br
.ti -1c
.RI "typedef ptrdiff_t \fBZyanISize\fP"
.br
.ti -1c
.RI "typedef uintptr_t \fBZyanUPointer\fP"
.br
.ti -1c
.RI "typedef intptr_t \fBZyanIPointer\fP"
.br
.ti -1c
.RI "typedef void * \fBZyanVoidPointer\fP"
.br
.ti -1c
.RI "typedef const void * \fBZyanConstVoidPointer\fP"
.br
.ti -1c
.RI "typedef ZyanU8 \fBZyanBool\fP"
.br
.ti -1c
.RI "typedef ZyanI8 \fBZyanTernary\fP"
.br
.ti -1c
.RI "typedef char * \fBZyanCharPointer\fP"
.br
.ti -1c
.RI "typedef const char * \fBZyanConstCharPointer\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanU8)==1)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanU16)==2)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanU32)==4)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanU64)==8)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanI8)==1)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanI16)==2)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanI32)==4)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanI64)==8)"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanUSize)==sizeof(void *))"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanISize)==sizeof(void *))"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanUPointer)==sizeof(void *))"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP (sizeof(ZyanIPointer)==sizeof(void *))"
.br
.ti -1c
.RI "\fBZYAN_STATIC_ASSERT\fP ((ZyanI8) \-1 > > 1<(ZyanI8)((ZyanU8) \-1 > > 1))"
.br
.in -1c
.SH "Detailed Description"
.PP 
Includes and defines some default data types\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef ZyanU8 \fBZyanBool\fP"
Defines the \fCZyanBool\fP data-type\&.
.PP
Represents a default boolean data-type where \fC0\fP is interpreted as \fCfalse\fP and all other values as \fCtrue\fP\&. 
.SS "typedef char* \fBZyanCharPointer\fP"
Defines the \fCZyanCharPointer\fP data-type\&.
.PP
This type is most often used to represent null-terminated strings aka\&. C-style strings\&. 
.SS "typedef const char* \fBZyanConstCharPointer\fP"
Defines the \fCZyanConstCharPointer\fP data-type\&.
.PP
This type is most often used to represent null-terminated strings aka\&. C-style strings\&. 
.SS "typedef const void* \fBZyanConstVoidPointer\fP"
Defines the \fCZyanConstVoidPointer\fP data-type\&. 
.SS "typedef ZyanI8 \fBZyanTernary\fP"
Defines the \fCZyanTernary\fP data-type\&.
.PP
The \fCZyanTernary\fP is a balanced ternary type that uses three truth values indicating \fCtrue\fP, \fCfalse\fP and an indeterminate third value\&. 
.SS "typedef void* \fBZyanVoidPointer\fP"
Defines the \fCZyanVoidPointer\fP data-type\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for Zycore from the source code\&.