FAndroidWindow Class Reference

#include <AndroidWindow.h>

Inheritance diagram for FAndroidWindow:

Classes
class	FNativeAccessor

Public Member Functions
APPLICATIONCORE_API	~FAndroidWindow ()
virtual APPLICATIONCORE_API void	Destroy () override
virtual void *	GetOSWindowHandle () const override
APPLICATIONCORE_API void	Initialize (class FAndroidApplication *const Application, const TSharedRef< FGenericWindowDefinition > &InDefinition, const TSharedPtr< FAndroidWindow > &InParent, const bool bShowImmediately)
virtual APPLICATIONCORE_API bool	GetFullScreenInfo (int32 &X, int32 &Y, int32 &Width, int32 &Height) const override
virtual APPLICATIONCORE_API void	SetOSWindowHandle (void *)
APPLICATIONCORE_API bool	GetNativeWindowResolution (int32_t &OutWidth, int32_t &OutHeight) const
virtual void	SetWindowMode (EWindowMode::Type InNewWindowMode)
FNativeAccessor	GetANativeAccessor (bool bWriteAccess)
Public Member Functions inherited from FGenericWindow
APPLICATIONCORE_API	FGenericWindow ()
virtual APPLICATIONCORE_API	~FGenericWindow ()
virtual APPLICATIONCORE_API void	ReshapeWindow (int32 X, int32 Y, int32 Width, int32 Height)
virtual APPLICATIONCORE_API void	MoveWindowTo (int32 X, int32 Y)
virtual APPLICATIONCORE_API void	BringToFront (bool bForce=false)
virtual APPLICATIONCORE_API void	HACK_ForceToFront ()
virtual APPLICATIONCORE_API void	Minimize ()
virtual APPLICATIONCORE_API void	Maximize ()
virtual APPLICATIONCORE_API void	Restore ()
virtual APPLICATIONCORE_API void	Show ()
virtual APPLICATIONCORE_API void	Hide ()
virtual APPLICATIONCORE_API bool	IsMaximized () const
virtual APPLICATIONCORE_API bool	IsMinimized () const
virtual APPLICATIONCORE_API bool	IsVisible () const
virtual APPLICATIONCORE_API bool	GetRestoredDimensions (int32 &X, int32 &Y, int32 &Width, int32 &Height)
virtual APPLICATIONCORE_API void	SetWindowFocus ()
virtual APPLICATIONCORE_API void	SetOpacity (const float InOpacity)
virtual APPLICATIONCORE_API void	Enable (bool bEnable)
virtual APPLICATIONCORE_API bool	IsPointInWindow (int32 X, int32 Y) const
virtual APPLICATIONCORE_API int32	GetWindowBorderSize () const
virtual APPLICATIONCORE_API int32	GetWindowTitleBarSize () const
virtual APPLICATIONCORE_API bool	IsForegroundWindow () const
virtual APPLICATIONCORE_API bool	IsFullscreenSupported () const
virtual APPLICATIONCORE_API void	SetText (const TCHAR *const Text)
virtual APPLICATIONCORE_API const FGenericWindowDefinition &	GetDefinition () const
virtual APPLICATIONCORE_API bool	IsDefinitionValid () const
virtual APPLICATIONCORE_API void	AdjustCachedSize (FVector2D &Size) const
virtual APPLICATIONCORE_API float	GetDPIScaleFactor () const
virtual APPLICATIONCORE_API void	SetDPIScaleFactor (const float Factor)
virtual APPLICATIONCORE_API bool	IsManualManageDPIChanges () const
virtual APPLICATIONCORE_API void	SetManualManageDPIChanges (const bool bAutoHandle)
virtual APPLICATIONCORE_API void	DrawAttention (const FWindowDrawAttentionParameters &Parameters)
virtual APPLICATIONCORE_API void	SetNativeWindowButtonsVisibility (bool bVisible)
Public Member Functions inherited from TSharedFromThis< FAndroidWindow >
TSharedRef< FAndroidWindow, Mode >	AsShared ()
TSharedRef< FAndroidWindow const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FAndroidWindow, Mode >	AsWeak ()
TWeakPtr< FAndroidWindow const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static APPLICATIONCORE_API TSharedRef< FAndroidWindow >	Make ()
static APPLICATIONCORE_API FPlatformRect	GetScreenRect (bool bUseEventThreadWindow=false)
static APPLICATIONCORE_API void	InvalidateCachedScreenRect ()
static APPLICATIONCORE_API void	CalculateSurfaceSize (int32_t &SurfaceWidth, int32_t &SurfaceHeight, bool bUseEventThreadWindow=false)
static APPLICATIONCORE_API bool	OnWindowOrientationChanged (EDeviceScreenOrientation DeviceScreenOrientation)
static APPLICATIONCORE_API int32	GetDepthBufferPreference ()
static APPLICATIONCORE_API void	AcquireWindowRef (ANativeWindow *InWindow)
static APPLICATIONCORE_API void	ReleaseWindowRef (ANativeWindow *InWindow)
static APPLICATIONCORE_API void *	GetHardwareWindow_EventThread ()
static APPLICATIONCORE_API void	SetHardwareWindow_EventThread (void *InWindow)
static APPLICATIONCORE_API void *	WaitForHardwareWindow ()
static APPLICATIONCORE_API bool	IsPortraitOrientation ()
static APPLICATIONCORE_API FVector4	GetSafezone (bool bPortrait)
static APPLICATIONCORE_API void	SetWindowDimensions_EventThread (ANativeWindow *DimensionWindow)
static APPLICATIONCORE_API void	EventManagerUpdateWindowDimensions (int32 Width, int32 Height)

Protected Member Functions
virtual EWindowMode::Type	GetWindowMode () const override
Protected Member Functions inherited from TSharedFromThis< FAndroidWindow >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Friends
class	FAndroidWindowManager

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FAndroidWindow >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)
Protected Attributes inherited from FGenericWindow
TSharedPtr< FGenericWindowDefinition >	Definition

Detailed Description

A platform specific implementation of FNativeWindow. Native windows provide platform-specific backing for and are always owned by an SWindow.

Constructor & Destructor Documentation

~FAndroidWindow()

FAndroidWindow::~FAndroidWindow

(

)

Member Function Documentation

AcquireWindowRef()

void FAndroidWindow::AcquireWindowRef ( ANativeWindow *  InWindow )

static

CalculateSurfaceSize()

void FAndroidWindow::CalculateSurfaceSize ( int32_t &  SurfaceWidth, int32_t &  SurfaceHeight, bool  bUseEventThreadWindow = false  )

static

Destroy()

void FAndroidWindow::Destroy ( )

overridevirtual

Native windows should implement this function by asking the OS to destroy OS-specific resource associated with the window (e.g. Win32 window handle)

Reimplemented from FGenericWindow.

EventManagerUpdateWindowDimensions()

void FAndroidWindow::EventManagerUpdateWindowDimensions ( int32  Width, int32  Height  )

static

GetANativeAccessor()

FNativeAccessor FAndroidWindow::GetANativeAccessor ( bool  bWriteAccess )

inline

GetDepthBufferPreference()

int32 FAndroidWindow::GetDepthBufferPreference ( )

static

GetFullScreenInfo()

bool FAndroidWindow::GetFullScreenInfo ( int32 &  X, int32 &  Y, int32 &  Width, int32 &  Height  ) const

overridevirtual

Returns the rectangle of the screen the window is associated with

Reimplemented from FGenericWindow.

GetHardwareWindow_EventThread()

void * FAndroidWindow::GetHardwareWindow_EventThread ( )

static

GetNativeWindowResolution()

bool FAndroidWindow::GetNativeWindowResolution	(	int32_t &	OutWidth,
		int32_t &	OutHeight
	)		const

GetOSWindowHandle()

virtual void * FAndroidWindow::GetOSWindowHandle ( ) const

inlineoverridevirtual

Gets the OS Window handle in the form of a void pointer for other API's

Reimplemented from FGenericWindow.

GetSafezone()

FVector4 FAndroidWindow::GetSafezone ( bool  bPortrait )

static

GetScreenRect()

FPlatformRect FAndroidWindow::GetScreenRect ( bool  bUseEventThreadWindow = false )

static

GetWindowMode()

virtual EWindowMode::Type FAndroidWindow::GetWindowMode ( ) const

inlineoverrideprotectedvirtual

Returns

true if the native window is currently in fullscreen mode, false otherwise

Reimplemented from FGenericWindow.

Initialize()

void FAndroidWindow::Initialize	(	class FAndroidApplication *const	Application,
		const TSharedRef< FGenericWindowDefinition > &	InDefinition,
		const TSharedPtr< FAndroidWindow > &	InParent,
		const bool	bShowImmediately
	)

InvalidateCachedScreenRect()

void FAndroidWindow::InvalidateCachedScreenRect ( )

static

IsPortraitOrientation()

bool FAndroidWindow::IsPortraitOrientation ( )

static

Make()

TSharedRef< FAndroidWindow > FAndroidWindow::Make ( )

static

Create a new FAndroidWindow.

Parameters

OwnerWindow	The SlateWindow for which we are crating a backing AndroidWindow
InParent	Parent iOS window; usually NULL.

OnWindowOrientationChanged()

bool FAndroidWindow::OnWindowOrientationChanged ( EDeviceScreenOrientation  DeviceScreenOrientation )

static

ReleaseWindowRef()

void FAndroidWindow::ReleaseWindowRef ( ANativeWindow *  InWindow )

static

SetHardwareWindow_EventThread()

void FAndroidWindow::SetHardwareWindow_EventThread ( void *  InWindow )

static

SetOSWindowHandle()

void FAndroidWindow::SetOSWindowHandle ( void *  InWindow )

virtual

SetWindowDimensions_EventThread()

void FAndroidWindow::SetWindowDimensions_EventThread ( ANativeWindow *  DimensionWindow )

static

SetWindowMode()

virtual void FAndroidWindow::SetWindowMode ( EWindowMode::Type  InNewWindowMode )

inlinevirtual

Toggle native window between fullscreen and normal mode

Reimplemented from FGenericWindow.

WaitForHardwareWindow()

void * FAndroidWindow::WaitForHardwareWindow ( )

static

Waits on the current thread for a hardware window and returns it. May return nullptr if the application is shutting down.

Friends And Related Symbol Documentation

FAndroidWindowManager

friend class FAndroidWindowManager

friend

---

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

• Engine/Source/Runtime/ApplicationCore/Public/Android/AndroidWindow.h
• Engine/Source/Runtime/ApplicationCore/Private/Android/AndroidWindow.cpp