Home

Resume

Blog

Teikitu


/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
/*  »Project«   Teikitu Gaming System (TgS) (∂)
    »File«      TgS Sound.h
    »Author«    Andrew Aye (EMail: mailto:andrew.aye@gmail.com, Web: http://www.andrewaye.com)
    »Version«   4.51 / »GUID« A9981407-3EC9-42AF-8B6F-8BE6DD919615                                                                                                        */
/*   -------------------------------------------------------------------------------------------------------------------------------------------------------------------- */
/*  Copyright: © 2002-2017, Andrew Aye.  All Rights Reserved.
    This software is free for non-commercial use.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
      following conditions are met:
        Redistribution of source code must retain this copyright notice, this list of conditions and the following disclaimers.
        Redistribution in binary form must reproduce this copyright notice, this list of conditions and the following disclaimers in the documentation and other materials
          provided with the distribution.
    The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
    The intellectual property rights of the algorithms used reside with Andrew Aye.
    You may not use this software, in whole or in part, in support of any commercial product without the express written consent of the author.
    There is no warranty or other guarantee of fitness of this software for any purpose. It is provided solely "as is".                                                   */
/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
#if !defined(_TGS_SOUND_H_)
#define _TGS_SOUND_H_
#pragma once

#if !defined(_TGS_PLATFORM_SOUND_H_)
#error This file should not be included directly - use the correct platform include wrapper
#endif

#include "TgS SOUND/TgS Sound - Constants.h"
#include "TgS SOUND/TgS Sound - Type.h"


/* == Sound =============================================================================================================================================================== */

/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Module Functions                                                                                                                                                      */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

TgEXTN TgRESULT                             tgSN_Init_Module( TgVOID ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Boot_Module( TgVOID ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Update_Module( C_TgFLOAT32 );  /* #TODO: Implement */ /* Client Only */
TgEXTN TgVOID                               tgSN_Stop_Module( TgVOID ); /* #TODO: Implement */
TgEXTN TgVOID                               tgSN_Free_Module( TgVOID ); /* #TODO: Implement */

TgEXTN TgRESULT                             tgSN_Load_Config( TgVOID ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Save_Config( TgVOID ); /* #TODO: Implement */

TgEXTN TgBOOL                               tgSN_Query_Init( TgVOID ); /* #TODO: Implement */
TgEXTN TgBOOL                               tgSN_Query_Boot( TgVOID ); /* #TODO: Implement */
TgEXTN TgSIZE                               tgSN_Query_Fixed_Memory( TgVOID ); /* #TODO: Implement */


/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Sound Functions                                                                                                                                                       */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

/* ---- Sound Instance -------------------------------------------------------------------------------------------------------------------------------------------------- */

                                            /* Sound Instance - Create a new sound instance from the descriptor */
TgEXTN TgSN_INST_ID                         tgSN_Sound_Inst__Init( C_TgSN_ID, PCU_STg2_SN_DESC_Sound_Inst ); /* #TODO: Implement */
TgEXTN TgVOID                               tgSN_Sound_Inst__Free( C_TgSN_INST_ID ); /* #TODO: Implement */

                                            /* Sound Instance - Post event to the instance */
                                            /* 1: Sound Instance */
                                            /* 2: Hash - Hash value of the event string name */
                                            /* 3: Parameter - Float parameter for event - common use is a time duration */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Event( C_TgSN_INST_ID, C_TgUINT64, C_TgFLOAT32 ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Event_Stop( C_TgSN_INST_ID ); /* #TODO: Implement */

                                            /* Sounds Instance - Function wrappers for common events */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Play( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Pause( C_TgSN_INST_ID, C_TgFLOAT32 ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Resume( C_TgSN_INST_ID, C_TgFLOAT32 ); /* #TODO: Implement */
TgEXTN TgRESULT                             tgSN_Sound_Inst__Stop( C_TgSN_INST_ID, C_TgFLOAT32 ); /* #TODO: Implement */

                                            /* Sound play back state accessors */
TgEXTN TgBOOL                               tgSN_Sound_Inst__Is_Valid( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgBOOL                               tgSN_Sound_Inst__Is_Playing( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgBOOL                               tgSN_Sound_Inst__Is_Paused( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgBOOL                               tgSN_Sound_Inst__Is_Stopped( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgBOOL                               tgSN_Sound_Inst__Is_Stereo( C_TgSN_INST_ID ); /* #TODO: Implement */

                                            /* Sound play back definition accessors */
TgEXTN TgVOID                               tgSN_Sound_Inst__Set_Position( C_TgSN_INST_ID, C_TgVEC_M_F32_04 ); /* #TODO: Implement */
TgEXTN TgVOID                               tgSN_Sound_Inst__Set_Direction( C_TgSN_INST_ID, C_TgVEC_M_F32_04 ); /* #TODO: Implement */
TgEXTN TgVOID                               tgSN_Sound_Inst__Set_Velocity( C_TgSN_INST_ID, C_TgVEC_M_F32_04 ); /* #TODO: Implement */

TgEXTN TgVEC_F32_04                         tgSN_Sound_Inst__Query_Position( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgVEC_F32_04                         tgSN_Sound_Inst__Query_Direction( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgVEC_F32_04                         tgSN_Sound_Inst__Query_Velocity( C_TgSN_INST_ID ); /* #TODO: Implement */
TgEXTN TgUINT32                             tgSN_Sound_Inst__Query_Category( C_TgSN_INST_ID ); /* #TODO: Implement */

/* ====================================================================================================================================================================== */
#endif