irrlicht/include/SExposedVideoData.h

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#pragma once

namespace irr
{
namespace video
{

//! structure for holding data describing a driver and operating system specific data.
/** This data can be retrieved by IVideoDriver::getExposedVideoData(). Use this with caution.
This only should be used to make it possible to extend the engine easily without
modification of its source. Note that this structure does not contain any valid data, if
you are using the software or the null device.
*/
struct SExposedVideoData
{
	SExposedVideoData()
	{
		OpenGLWin32.HDc = 0;
		OpenGLWin32.HRc = 0;
		OpenGLWin32.HWnd = 0;
	}
	explicit SExposedVideoData(void *Window)
	{
		OpenGLWin32.HDc = 0;
		OpenGLWin32.HRc = 0;
		OpenGLWin32.HWnd = Window;
	}

	struct SOpenGLWin32
	{
		//! Private GDI Device Context.
		/** Get if for example with: HDC h = reinterpret_cast<HDC>(exposedData.OpenGLWin32.HDc) */
		void *HDc;

		//! Permanent Rendering Context.
		/** Get if for example with: HGLRC h = reinterpret_cast<HGLRC>(exposedData.OpenGLWin32.HRc) */
		void *HRc;

		//! Window handle.
		/** Get with for example with: HWND h = reinterpret_cast<HWND>(exposedData.OpenGLWin32.HWnd) */
		void *HWnd;
	};

	struct SOpenGLLinux
	{
		// XWindow handles
		void *X11Display;
		void *X11Context;
		unsigned long X11Window;
		unsigned long GLXWindow;
	};

	struct SOpenGLOSX
	{
		//! The NSOpenGLContext object.
		void *Context;

		//! The NSWindow object.
		void *Window;
	};

	struct SOpenGLFB
	{
		//! The EGLNativeWindowType object.
		void *Window;
	};

	struct SOGLESAndroid
	{
		//! The ANativeWindow object.
		void *Window;
	};

	union
	{
		SOpenGLWin32 OpenGLWin32;
		SOpenGLLinux OpenGLLinux;
		SOpenGLOSX OpenGLOSX;
		SOpenGLFB OpenGLFB;
		SOGLESAndroid OGLESAndroid;
	};
};

} // end namespace video
} // end namespace irr