include/AK/Tools/Win32/AkPlatformFuncs.h File Reference

Go to the source code of this file.

Classes
struct	AkThreadProperties
Namespaces
namespace	AK
	Audiokinetic namespace.
namespace	AKPLATFORM
Defines
#define	AK_DECLARE_THREAD_ROUTINE(FuncName) DWORD WINAPI FuncName(LPVOID lpParameter)
#define	AK_THREAD_RETURN(_param_) return (_param_);
#define	AK_THREAD_ROUTINE_PARAMETER lpParameter
#define	AK_GET_THREAD_ROUTINE_PARAMETER_PTR(type) reinterpret_cast<type*>( AK_THREAD_ROUTINE_PARAMETER )
#define	AK_RETURN_THREAD_OK 0x00000000
#define	AK_RETURN_THREAD_ERROR 0x00000001
#define	AK_DEFAULT_STACK_SIZE (65536)
#define	AK_THREAD_PRIORITY_NORMAL THREAD_PRIORITY_NORMAL
#define	AK_THREAD_PRIORITY_ABOVE_NORMAL THREAD_PRIORITY_ABOVE_NORMAL
#define	AK_NULL_THREAD NULL
#define	AK_INFINITE INFINITE
#define	AkMax(x1, x2) (((x1) > (x2))? (x1): (x2))
#define	AkMin(x1, x2) (((x1) < (x2))? (x1): (x2))
#define	AkClamp(x, min, max) ((x) < (min)) ? (min) : (((x) > (max) ? (max) : (x)))
#define	AkExitThread(_result) return _result;
#define	AkAlloca(_size_) _alloca( _size_ )
	Stack allocations.
#define	CONVERT_WIDE_TO_OSCHAR(_wstring_, _oscharstring_) ( _oscharstring_ ) = (AkOSChar*)( _wstring_ )
#define	CONVERT_CHAR_TO_OSCHAR(_astring_, _oscharstring_)
#define	CONVERT_OSCHAR_TO_WIDE(_osstring_, _wstring_) _wstring_ = _osstring_
#define	CONVERT_OSCHAR_TO_CHAR(_osstring_, _astring_)
#define	AK_OSPRINTF swprintf_s
	AkOSChar version of sprintf().
#define	AK_UTF16_TO_WCHAR(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::SafeStrCpy( in_pdDest, in_pSrc, in_MaxSize )
#define	AK_WCHAR_TO_UTF16(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::SafeStrCpy( in_pdDest, in_pSrc, in_MaxSize )
#define	AK_UTF16_TO_OSCHAR(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::SafeStrCpy( in_pdDest, in_pSrc, in_MaxSize )
#define	AK_UTF16_TO_CHAR(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::AkWideCharToChar( in_pSrc, in_MaxSize, in_pdDest )
#define	AK_CHAR_TO_UTF16(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::AkCharToWideChar( in_pSrc, in_MaxSize, in_pdDest )
#define	AK_OSCHAR_TO_UTF16(in_pdDest, in_pSrc, in_MaxSize) AKPLATFORM::SafeStrCpy( in_pdDest, in_pSrc, in_MaxSize )
#define	AK_PATH_SEPARATOR (L"\\")
Functions
void	AKPLATFORM::AkClearEvent (AkEvent &out_event)
	Platform Independent Helper.
AKRESULT	AKPLATFORM::AkCreateEvent (AkEvent &out_event)
	Platform Independent Helper.
void	AKPLATFORM::AkDestroyEvent (AkEvent &io_event)
	Platform Independent Helper.
void	AKPLATFORM::AkWaitForEvent (AkEvent &in_event)
	Platform Independent Helper.
void	AKPLATFORM::AkSignalEvent (const AkEvent &in_event)
	Platform Independent Helper.
AkInt32	AKPLATFORM::AkInterlockedIncrement (AkAtomic32 *pValue)
	Platform Independent Helper.
AkInt32	AKPLATFORM::AkInterlockedDecrement (AkAtomic32 *pValue)
	Platform Independent Helper.
bool	AKPLATFORM::AkInterlockedCompareExchange (volatile AkAtomic64 *io_pDest, AkInt64 in_newValue, AkInt64 in_expectedOldVal)
bool	AKPLATFORM::AkInterlockedCompareExchange (volatile AkAtomic32 *io_pDest, AkInt32 in_newValue, AkInt32 in_expectedOldVal)
bool	AKPLATFORM::AkInterlockedCompareExchange (volatile AkAtomicPtr *io_pDest, AkIntPtr in_newValue, AkIntPtr in_expectedOldVal)
void	AKPLATFORM::AkMemoryBarrier ()
bool	AKPLATFORM::AkIsValidThread (AkThread *in_pThread)
	Platform Independent Helper.
void	AKPLATFORM::AkClearThread (AkThread *in_pThread)
	Platform Independent Helper.
void	AKPLATFORM::AkCloseThread (AkThread *in_pThread)
	Platform Independent Helper.
void	AKPLATFORM::AkGetDefaultThreadProperties (AkThreadProperties &out_threadProperties)
	Platform Independent Helper.
void	AKPLATFORM::AkSetThreadName (DWORD in_dwThreadID, LPCSTR in_szThreadName)
	Set the name of a thread: see http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx.
void	AKPLATFORM::AkCreateThread (AkThreadRoutine pStartRoutine, void pParams, const AkThreadProperties &in_threadProperties, AkThread out_pThread, const char *)
	Platform Independent Helper.
void	AKPLATFORM::AkWaitForSingleThread (AkThread *in_pThread)
	Platform Independent Helper.
AkThreadID	AKPLATFORM::CurrentThread ()
	Returns the calling thread's ID.
void	AKPLATFORM::AkSleep (AkUInt32 in_ulMilliseconds)
	Platform Independent Helper.
void	AKPLATFORM::AkMemCpy (void pDest, const void pSrc, AkUInt32 uSize)
	Platform Independent Helper.
void	AKPLATFORM::AkMemSet (void *pDest, AkInt32 iVal, AkUInt32 uSize)
	Platform Independent Helper.
void	AKPLATFORM::PerformanceCounter (AkInt64 *out_piLastTime)
	Platform Independent Helper.
void	AKPLATFORM::PerformanceFrequency (AkInt64 *out_piFreq)
	Platform Independent Helper.
void	AKPLATFORM::UpdatePerformanceFrequency ()
	Platform Independent Helper.
AkReal32	AKPLATFORM::Elapsed (const AkInt64 &in_iNow, const AkInt64 &in_iStart)
	Returns a time range in milliseconds, using the sound engine's updated count->milliseconds ratio.
AkInt32	AKPLATFORM::AkWideCharToChar (const wchar_t in_pszUnicodeString, AkUInt32 in_uiOutBufferSize, char io_pszAnsiString)
	String conversion helper.
AkInt32	AKPLATFORM::AkCharToWideChar (const char in_pszAnsiString, AkUInt32 in_uiOutBufferSize, void io_pvUnicodeStringBuffer)
	String conversion helper.
AkInt32	AKPLATFORM::AkUtf8ToWideChar (const char in_pszUtf8String, AkUInt32 in_uiOutBufferSize, void io_pvUnicodeStringBuffer)
	String conversion helper.
void	AKPLATFORM::SafeStrCpy (wchar_t in_pDest, const wchar_t in_pSrc, size_t in_uDestMaxNumChars)
	Safe unicode string copy.
void	AKPLATFORM::SafeStrCpy (char in_pDest, const char in_pSrc, size_t in_uDestMaxNumChars)
	Safe ansi string copy.
void	AKPLATFORM::SafeStrCat (wchar_t in_pDest, const wchar_t in_pSrc, size_t in_uDestMaxNumChars)
	Safe unicode string concatenation.
void	AKPLATFORM::SafeStrCat (char in_pDest, const char in_pSrc, size_t in_uDestMaxNumChars)
	Safe ansi string concatenation.
void	AKPLATFORM::OutputDebugMsg (const wchar_t *in_pszMsg)
	Output a debug message on the console (Unicode string).
void	AKPLATFORM::OutputDebugMsg (const char *in_pszMsg)
	Output a debug message on the console (Ansi string).
size_t	AKPLATFORM::AkUtf16StrLen (const AkUtf16 *in_pStr)
size_t	AKPLATFORM::OsStrLen (const AkOSChar *in_pszString)
int	AKPLATFORM::OsStrCmp (const AkOSChar in_pszString1, const AkOSChar in_pszString2)

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Get started with Wwise

Wwise SDK 2016.2.6

include/AK/Tools/Win32/AkPlatformFuncs.h

include/AK/Tools/Win32/AkPlatformFuncs.h File Reference

Classes

Namespaces

Defines

Functions

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.