BansheeEngine/Source/BansheeCore/Linux/BsLinuxPlatform.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "Platform/BsPlatform.h"
#include <X11/X.h>
#include <X11/Xlib.h>

namespace bs
{
	class LinuxWindow;

	/** @addtogroup Platform-Internal
	 *  @{
	 */

	/**
	 * Contains various Linux specific platform functionality;
	 */
	class BS_CORE_EXPORT LinuxPlatform : public Platform
	{
	public:
		/** Returns the active X11 display. */
		static ::Display* getXDisplay();

		/** Returns the main X11 window. Caller must ensure the main window has been created. */
		static ::Window getMainXWindow();

		/** Retruns the absolute path to the user's home directory. */
		static Path getHomeDir();

		/** Locks access to the X11 system, not allowing any other thread to access it. Must be used for every X11 access. */
		static void lockX();

		/** Unlocks access to the X11 system. Must follow every call to lockX(). */
		static void unlockX();

		/** Notifies the system that a new window was created. */
		static void _registerWindow(::Window xWindow, LinuxWindow* window);

		/** Notifies the system that a window is about to be destroyed. */
		static void _unregisterWindow(::Window xWindow);

		/** Generates a X11 Pixmap from the provided pixel data. */
		static Pixmap createPixmap(const PixelData& data, UINT32 depth);
	};

	/** @} */
}