#include <OgreOSXCocoaWindow.h>

Inheritance diagram for Ogre::CocoaWindow:

Public Member Functions
	CocoaWindow (const String &title, uint32 widthPt, uint32 heightPt, bool fullscreenMode)

virtual	~CocoaWindow ()

void	_initialize (TextureGpuManager *textureManager) override
	Window::_initialize More...

void	_setPrimary ()
	Indicates that this is the primary window. More...

void	_setVisible (bool visible) override
	Window::_setVisible More...

void	create (const String &name, unsigned int widthPt, unsigned int heightPt, bool fullScreen, const NameValuePairList *miscParams)

void	destroy () override
	Window::destroy More...

bool	getBorderless () const

void	getCustomAttribute (IdString name, void *pData)
	Window::getCustomAttribute More...

TextureGpu *	getDepthBuffer () const

uint32	getFrequencyDenominator () const

uint32	getFrequencyNumerator () const

uint32	getHeight () const

virtual void	getMetrics (uint32 &width, uint32 &height, int32 &left, int32 &top) const
	Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More...

PixelFormatGpu	getPixelFormat () const

uint32	getRequestedHeightPt () const

uint32	getRequestedWidthPt () const

SampleDescription	getSampleDescription () const

TextureGpu *	getStencilBuffer () const

TextureGpu *	getTexture () const
	WARNING: Attempting to change the TextureGpu (e.g. More...

const String &	getTitle () const

float	getViewPointToPixelScale () const override
	Window::setVSync More...

bool	getVSync () const

uint32	getVSyncInterval () const

uint32	getWidth () const

bool	isActive () const

bool	isClosed () const override
	Window::isClosed More...

bool	isDeactivatedOnFocusChange () const

bool	isFocused () const

bool	isFullscreen () const
	Returns true if we are currently in fullscreen mode. More...

bool	isHidden () const override
	Window::isHidden More...

bool	isMultisample () const

bool	isPrimary () const

bool	isVisible () const override
	Window::isVisible More...

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void	reposition (int leftPt, int topPt) override
	Window::reposition More...

virtual void	reposition (int32 leftPt, int32 topPt)=0

virtual void	requestFullscreenSwitch (bool goFullscreen, bool borderless, uint32 monitorIdx, uint32 widthPt, uint32 heightPt, uint32 frequencyNumerator, uint32 frequencyDenominator)
	Requests to toggle between fullscreen and windowed mode. More...

virtual void	requestResolution (uint32 widthPt, uint32 heightPt)
	Requests a change in resolution. More...

void	setActive (bool value)

virtual void	setBorderless (bool borderless)

void	setDeactivateOnFocusChange (bool deactivate)

virtual void	setFocused (bool focused)

virtual void	setFsaa (const String &fsaa)
	Set the FSAA mode to be used if hardware support it. More...

void	setHidden (bool hidden) override
	RenderWindow::setHidden More...

virtual void	setTitle (const String &title)

void	setVisible (bool visible)

virtual void	setVSync (bool vSync, uint32 vSyncInterval)
	Turns VSync on/off. More...

void	swapBuffers () override
	Window::swapBuffers More...

bool	wantsToGoFullscreen () const
	Returns true if we are in windowed mode right now, but want to go fullscreen. More...

bool	wantsToGoWindowed () const
	Returns true if we are in fullscreen mode right now, but want to go windowed mode. More...

void	windowMovedOrResized () override
	Window::windowMovedOrResized More...

Constructor & Destructor Documentation

◆ CocoaWindow()

Ogre::CocoaWindow::CocoaWindow	(	const String &	title,
		uint32	widthPt,
		uint32	heightPt,
		bool	fullscreenMode
	)

◆ ~CocoaWindow()

virtual Ogre::CocoaWindow::~CocoaWindow ( )

virtual

Member Function Documentation

◆ _initialize()

void Ogre::CocoaWindow::_initialize ( TextureGpuManager * textureManager )

overridevirtual

Window::_initialize

Implements Ogre::Window.

◆ _setPrimary()

void Ogre::Window::_setPrimary ( )

inherited

Indicates that this is the primary window.

Only to be called by Ogre::Root

◆ _setVisible()

void Ogre::CocoaWindow::_setVisible ( bool visible )

overridevirtual

Window::_setVisible

Implements Ogre::Window.

◆ create()

void Ogre::CocoaWindow::create	(	const String &	name,
		unsigned int	widthPt,
		unsigned int	heightPt,
		bool	fullScreen,
		const NameValuePairList *	miscParams
	)

◆ destroy()

void Ogre::CocoaWindow::destroy ( )

overridevirtual

Window::destroy

Implements Ogre::Window.

◆ getBorderless()

bool Ogre::Window::getBorderless ( ) const

inherited

◆ getCustomAttribute()

void Ogre::CocoaWindow::getCustomAttribute	(	IdString	name,
		void *	pData
	)

virtual

Window::getCustomAttribute

Remarks: Get custom attribute; the following attributes are valid: GLCONTEXT WINDOW VIEW NSOPENGLCONTEXT NSOPENGLPIXELFORMAT

Reimplemented from Ogre::Window.

◆ getDepthBuffer()

TextureGpu* Ogre::Window::getDepthBuffer ( ) const

inherited

◆ getFrequencyDenominator()

uint32 Ogre::Window::getFrequencyDenominator ( ) const

inherited

◆ getFrequencyNumerator()

uint32 Ogre::Window::getFrequencyNumerator ( ) const

inherited

◆ getHeight()

uint32 Ogre::Window::getHeight ( ) const

inherited

◆ getMetrics()

virtual void Ogre::Window::getMetrics	(	uint32 &	width,
		uint32 &	height,
		int32 &	left,
		int32 &	top
	)		const

virtualinherited

Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

Result is in pixels.

◆ getPixelFormat()

PixelFormatGpu Ogre::Window::getPixelFormat ( ) const

inherited

◆ getRequestedHeightPt()

uint32 Ogre::Window::getRequestedHeightPt ( ) const

inherited

◆ getRequestedWidthPt()

uint32 Ogre::Window::getRequestedWidthPt ( ) const

inherited

◆ getSampleDescription()

SampleDescription Ogre::Window::getSampleDescription ( ) const

inherited

◆ getStencilBuffer()

TextureGpu* Ogre::Window::getStencilBuffer ( ) const

inherited

◆ getTexture()

TextureGpu* Ogre::Window::getTexture ( ) const

inherited

WARNING: Attempting to change the TextureGpu (e.g.

setResolution, setPixelFormat) is undefined behavior

◆ getTitle()

const String& Ogre::Window::getTitle ( ) const

inherited

◆ getViewPointToPixelScale()

float Ogre::CocoaWindow::getViewPointToPixelScale ( ) const

overridevirtual

Window::setVSync

Window::getViewPointToPixelScale Window::getViewPointToPixelScale

Reimplemented from Ogre::Window.

◆ getVSync()

bool Ogre::Window::getVSync ( ) const

inherited

◆ getVSyncInterval()

uint32 Ogre::Window::getVSyncInterval ( ) const

inherited

◆ getWidth()

uint32 Ogre::Window::getWidth ( ) const

inherited

◆ isActive()

bool Ogre::CocoaWindow::isActive ( ) const

◆ isClosed()

bool Ogre::CocoaWindow::isClosed ( ) const

overridevirtual

Window::isClosed

Implements Ogre::Window.

◆ isDeactivatedOnFocusChange()

bool Ogre::CocoaWindow::isDeactivatedOnFocusChange ( ) const

◆ isFocused()

bool Ogre::Window::isFocused ( ) const

inherited

◆ isFullscreen()

bool Ogre::Window::isFullscreen ( ) const

inherited

Returns true if we are currently in fullscreen mode.

◆ isHidden()

bool Ogre::CocoaWindow::isHidden ( ) const

inlineoverridevirtual

Window::isHidden

Implements Ogre::Window.

◆ isMultisample()

bool Ogre::Window::isMultisample ( ) const

inherited

◆ isPrimary()

bool Ogre::Window::isPrimary ( ) const

inherited

◆ isVisible()

bool Ogre::CocoaWindow::isVisible ( ) const

overridevirtual

Window::isVisible

Implements Ogre::Window.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ reposition() [1/2]

void Ogre::CocoaWindow::reposition	(	int	leftPt,
		int	topPt
	)

override

Window::reposition

◆ reposition() [2/2]

virtual void Ogre::Window::reposition	(	int32	leftPt,
		int32	topPt
	)

pure virtualinherited

Implemented in Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::VulkanAndroidWindow, Ogre::GLXWindow, Ogre::NULLWindow, Ogre::MetalWindow, Ogre::Win32Window, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ requestFullscreenSwitch()

virtual void Ogre::Window::requestFullscreenSwitch	(	bool	goFullscreen,
		bool	borderless,
		uint32	monitorIdx,
		uint32	widthPt,
		uint32	heightPt,
		uint32	frequencyNumerator,
		uint32	frequencyDenominator
	)

virtualinherited

Requests to toggle between fullscreen and windowed mode.

Remarks: Use wantsToGoFullscreen & wantsToGoWindowed to know what you've requested. Same remarks as requestResolution apply: If we request to go fullscreen, wantsToGoFullscreen will return true. But if get word from OS saying we stay in windowed mode, wantsToGoFullscreen will start returning false.

Parameters

goFullscreen	True to go fullscreen, false to go windowed mode.
borderless	Whether to be borderless. Only useful if goFullscreen == false;
monitorIdx
width	New width. Leave 0 if you don't care.
height	New height. Leave 0 if you don't care.
frequencyNumerator	New frequency (fullscreen only). Leave 0 if you don't care.
frequencyDenominator	New frequency (fullscreen only). Leave 0 if you don't care.

Reimplemented in Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::GLXWindow, Ogre::NULLWindow, Ogre::Win32Window, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ requestResolution()

virtual void Ogre::Window::requestResolution	(	uint32	widthPt,
		uint32	heightPt
	)

virtualinherited

Requests a change in resolution.

Change is not immediate. Use getRequestedWidthPt & getRequestedHeightPt if you need to know what you've requested, but beware you may not get that resolution, and once we get word from the OS, getRequested{Width/Height}Pt will change again so that getWidth == getRequestedWidthPt * getViewPointToPixelScale.

Reimplemented in Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::VulkanAndroidWindow, Ogre::GLXWindow, Ogre::NULLWindow, Ogre::MetalWindow, Ogre::Win32Window, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ setActive()

void Ogre::CocoaWindow::setActive ( bool value )

◆ setBorderless()

virtual void Ogre::Window::setBorderless ( bool borderless )

virtualinherited

◆ setDeactivateOnFocusChange()

void Ogre::CocoaWindow::setDeactivateOnFocusChange ( bool deactivate )

◆ setFocused()

virtual void Ogre::Window::setFocused ( bool focused )

virtualinherited

Reimplemented in Ogre::VulkanWin32Window, and Ogre::Win32Window.

◆ setFsaa()

virtual void Ogre::Window::setFsaa ( const String & fsaa )

inlinevirtualinherited

Set the FSAA mode to be used if hardware support it.

This option will be ignored if the hardware does not support it or setting can not be changed on the fly on per-target level.

Parameters

fsaa	Requesed FSAA mode (

See also: Root::createRenderWindow)

Reimplemented in Ogre::D3D11WindowSwapChainBased.

◆ setHidden()

void Ogre::CocoaWindow::setHidden ( bool hidden )

overridevirtual

RenderWindow::setHidden

Implements Ogre::Window.

◆ setTitle()

virtual void Ogre::Window::setTitle ( const String & title )

virtualinherited

◆ setVisible()

void Ogre::CocoaWindow::setVisible ( bool visible )

◆ setVSync()

virtual void Ogre::Window::setVSync	(	bool	vSync,
		uint32	vSyncInterval
	)

virtualinherited

Turns VSync on/off.

Parameters

vSync
vSyncInterval	When true, specifies how often the screen should be updated. e.g. at 60hz: vSyncInterval = 1 then update at 60hz vSyncInterval = 2 then update at 30hz vSyncInterval = 3 then update at 15hz vSyncInterval = 4 then update at 7.5hz

If the 31st bit is set, i.e. 0x80000000, then lowest latency mode, aka mailbox, will be used (which doesn't limit the framerate)

Reimplemented in Ogre::VulkanWindow, Ogre::GLXWindow, Ogre::Win32Window, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ swapBuffers()

void Ogre::CocoaWindow::swapBuffers ( )

overridevirtual

Window::swapBuffers

Implements Ogre::Window.

◆ wantsToGoFullscreen()

bool Ogre::Window::wantsToGoFullscreen ( ) const

inherited

Returns true if we are in windowed mode right now, but want to go fullscreen.

◆ wantsToGoWindowed()

bool Ogre::Window::wantsToGoWindowed ( ) const

inherited

Returns true if we are in fullscreen mode right now, but want to go windowed mode.

◆ windowMovedOrResized()

void Ogre::CocoaWindow::windowMovedOrResized ( )

overridevirtual

Window::windowMovedOrResized

Reimplemented from Ogre::Window.

The documentation for this class was generated from the following file:

OgreOSXCocoaWindow.h

Public Member Functions

Constructor & Destructor Documentation

◆ CocoaWindow()

◆ ~CocoaWindow()

Member Function Documentation

◆ _initialize()

◆ _setPrimary()

◆ _setVisible()

◆ create()

◆ destroy()

◆ getBorderless()

◆ getCustomAttribute()

◆ getDepthBuffer()

◆ getFrequencyDenominator()

◆ getFrequencyNumerator()

◆ getHeight()

◆ getMetrics()

◆ getPixelFormat()

◆ getRequestedHeightPt()

◆ getRequestedWidthPt()

◆ getSampleDescription()

◆ getStencilBuffer()

◆ getTexture()

◆ getTitle()

◆ getViewPointToPixelScale()

◆ getVSync()

◆ getVSyncInterval()

◆ getWidth()

◆ isActive()

◆ isClosed()

◆ isDeactivatedOnFocusChange()

◆ isFocused()

◆ isFullscreen()

◆ isHidden()

◆ isMultisample()

◆ isPrimary()

◆ isVisible()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ reposition() [1/2]

◆ reposition() [2/2]

◆ requestFullscreenSwitch()

◆ requestResolution()

◆ setActive()

◆ setBorderless()

◆ setDeactivateOnFocusChange()

◆ setFocused()

◆ setFsaa()

◆ setHidden()

◆ setTitle()

◆ setVisible()

◆ setVSync()

◆ swapBuffers()

◆ wantsToGoFullscreen()

◆ wantsToGoWindowed()

◆ windowMovedOrResized()