root/cafu/trunk/Libs/PlatformAux.hpp

/*
=================================================================================
This file is part of Cafu, the open-source game engine and graphics engine
for multiplayer, cross-platform, real-time 3D action.
Copyright (C) 2002-2012 Carsten Fuchs Software.

Cafu is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.

Cafu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Cafu. If not, see <http://www.gnu.org/licenses/>.

For support and more information about Cafu, visit us at <http://www.cafu.de>.
=================================================================================
*/

#ifndef CAFU_PLATFORM_AUX_HPP_INCLUDED
#define CAFU_PLATFORM_AUX_HPP_INCLUDED

#ifdef _WIN32
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#elif __linux__
#define HMODULE void*
#endif

#include <string>

namespace MatSys
{
    class RendererI;
    class TextureMapManagerI;
}

class SoundSysI;


namespace PlatformAux
{
    /// Returns a file suffix that indicates the platform, the compiler, and the debug/release switch setting.
    /// Examples include "_win32_ow_r", "_li686_g++_d", etc.
    /// @return   The suffix that indicates the platform, compiler, and debug/release built.
    std::string GetEnvFileSuffix();

    /// Gets the renderer by name.
    /// @param DLLName         The path and full name of the desired renderer DLL, e.g. "Renderers/RendererNull_win32_vc60_r.dll".
    /// @param OutRendererDLL  On success, returns the DLL handle of the renderer.
    /// @return   On success, the pointer to the implementation of the MatSys::RendererI. NULL on failure.
    MatSys::RendererI* GetRenderer(const std::string& DLLName, HMODULE& OutRendererDLL);

    /// Auto-selects the "best" renderer from the "Renderers/" subdirectory.
    /// @param OutRendererDLL On success, returns the DLL handle of the best renderer.
    /// @return   On success, the pointer to the implementation of the best MatSys::RendererI. NULL on failure.
    MatSys::RendererI* GetBestRenderer(HMODULE& OutRendererDLL);

    /// Returns the MatSys::TextureMapManagerI implementation of the RendererDLL.
    /// @param RendererDLL   The renderer DLL for which the texture manager should be returned.
    /// @return   On success the MatSys::TextureMapManagerI implementation of the RendererDLL. NULL on failure.
    MatSys::TextureMapManagerI* GetTextureMapManager(HMODULE RendererDLL);

    /// Gets the sound system by name.
    /// @param DLLName         The path and full name of the desired sound system DLL.
    /// @param OutSoundSysDLL  On success, returns the DLL handle of the sound system.
    /// @return On success, the pointer to the implementation of the SoundSysI. NULL on failure.
    SoundSysI* GetSoundSys(const std::string& DLLName, HMODULE& OutSoundSysDLL);

    /// Auto-selects the "best" sound system from the "SoundSys/" subdirectory.
    /// @param  OutSoundSysDLL On success, returns the DLL handle of the best sound system.
    /// @return On success, the pointer to the implementation of the best SoundSysI. NULL on failure.
    SoundSysI* GetBestSoundSys(HMODULE& OutSoundSysDLL);

}

#endif