Choose your operating system:
Windows
macOS
Linux
| FViewportFrame | ||
| FViewport | ||
| ISlateViewport | ||
| IViewportRenderTargetProvider
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/Slate/SceneViewport.h |
Include |
#include "Slate/SceneViewport.h" |
class FSceneViewport :
public FViewportFrame,
public FViewport,
public ISlateViewport,
public IViewportRenderTargetProvider
A viewport for use with SlateSViewport widgets.
Name | Description | |
---|---|---|
|
FSceneViewport ( |
Name | Description | |
---|---|---|
|
~FSceneViewport() |
Name | Description | ||
---|---|---|---|
|
TSharedPtr< ... |
FindWindow() |
|
|
const FGeome... |
GetCachedGeometry() |
Get the cached viewport geometry. |
|
GetPlayInEditorIsSimulate() |
||
|
GetViewportWidget() |
||
|
HasFixedSize() |
Does the viewport has a fixed size |
|
|
OnPlayWorldViewportSwapped ( |
Performs a resize when in swapping viewports while viewing the play world. |
|
|
PaintDebugCanvas ( |
Adds a draw element for the debug canvas. |
|
|
SetDebugCanvas ( |
Sets the debug canvas used to display FCanvas on top of this viewport |
|
|
SetFixedViewportSize |
||
|
SetGammaOverride ( |
Set an optional display gamma to use for this viewport |
|
|
SetOnSceneViewportResizeDel ( |
Sets the Viewport resize delegate. |
|
|
SetPlayInEditorGetsMouseControl ( |
Sets whether a PIE viewport takes mouse control on startup. |
|
|
SetPlayInEditorIsSimulate ( |
||
|
SetRenderTargetTextureRenderThread ( |
||
|
SetViewportSize |
||
|
SwapStatCommands ( |
Swaps the active stats with another viewports |
Name | Description | ||
---|---|---|---|
|
FViewport &#... |
GetViewport() |
FViewportFrame interface |
|
ResizeFrame ( |
Called to resize the actual window where this viewport resides |
Name | Description | ||
---|---|---|---|
|
BeginRenderFrame ( |
Called when a frame starts to render |
|
|
CaptureMouse ( |
||
|
DeferInvalidateHitProxy() |
Invalidates the viewport's cached hit proxies at the end of the frame. |
|
|
EndRenderFrame ( |
Called when a frame is done rendering |
|
|
EnqueueBeginRenderFrame ( |
Called before BeginRenderFrame is enqueued |
|
|
EnqueueEndRenderFrame |
Ends a rendering frame. Called from the game thread. |
|
|
FCanvas *... |
GetDebugCanvas() |
|
|
GetMousePos |
Sets MousePosition to the current mouse position |
|
|
GetMouseX() |
||
|
GetMouseY() |
||
|
GetRenderTargetTextureSizeXY() |
Returns dimensions of RenderTarget texture. Can be called on a game thread. |
|
|
FViewportFra... |
GetViewportFrame() |
Retrieves the interface to the viewport's frame, if it has one. |
|
void * |
GetWindow() |
|
|
HasFocus() |
||
|
HasMouseCapture() |
New MouseCapture/MouseLock API. |
|
|
InvalidateDisplay() |
Called when the viewport should be invalidated and redrawn |
|
|
IsCursorVisible() |
Returns true if the mouse cursor is currently visible |
|
|
IsForegroundWindow() |
||
|
IsSoftwareCursorVisible() |
||
|
IsStereoRenderingAllowed() |
Should return true, if stereo rendering is allowed in this viewport |
|
|
KeyState ( |
Returns the state of the provided key. |
|
|
LockMouseToViewport ( |
||
|
MoveWindow |
FViewport interface |
|
|
ProcessInput ( |
Additional input processing that happens every frame |
|
|
SetMouse |
Not implemented |
|
|
SetPreCaptureMousePosFromSlateCursor() |
Sets PreCapture coordinates from the current position of the slate cursor. |
|
|
SetRequiresVsync ( |
Indicate that the viewport should be block for vsync. |
|
|
SetSoftwareCursorPosition ( |
||
|
SetUserFocus ( |
Captures or uncaptures the joystick |
|
|
ShowCursor ( |
||
|
ShowSoftwareCursor ( |
||
|
UpdateViewportRHI ( |
Updates the viewport RHI with a new size and fullscreen flag |
|
|
ViewportToVirtualDesktopPixel ( |
Transforms a coordinate in the local space of this viewport into a virtual desktop pixel. |
|
|
VirtualDesktopPixelToViewport ( |
Transforms a virtual desktop pixel (the origin is in the primary screen's top left corner) to the local space of this viewport |
Name | Description | ||
---|---|---|---|
|
float |
GetDisplayGamma() |
|
|
const FTextu... |
GetRenderTargetTexture() |
Gets the proper RenderTarget based on the current thread |
Name | Description | ||
---|---|---|---|
|
GetSize() |
Returns the size of the viewport |
|
|
GetSoftwareCursorPosition() |
Returns the current position of the software cursor |
|
|
FSlateShader... |
GetViewportRenderTargetTexture() |
ISlateViewport interface |
|
GetWidget() |
Gets the SWidget associated with this viewport |
|
|
HandleNavigation ( |
Give the viewport an opportunity to override the navigation behavior. |
|
|
OnAnalogValueChanged ( |
Called when an analog value changes on a button that supports analog |
|
|
OnCursorQuery ( |
Called when Slate needs to know what the mouse cursor should be. |
|
|
OnDrawViewport ( |
Called by Slate when the viewport widget is drawn Implementers of this interface can use this method to perform custom per draw functionality. |
|
|
OnFinishedPointerInput() |
Called after all input for this frame is processed. |
|
|
OnFocusLost ( |
Called when the viewport loses keyboard focus. |
|
|
OnFocusReceived ( |
Called when the viewport gains keyboard focus. |
|
|
OnKeyChar ( |
Called by Slate when a character key is pressed while the viewport has focus |
|
|
OnKeyDown |
Called by Slate when a key is pressed inside the viewport |
|
|
OnKeyUp |
Called by Slate when a key is released inside the viewport |
|
|
OnMapCursor ( |
After OnCursorQuery has specified a cursor type the system asks each widget under the mouse to map that cursor to a widget. |
|
|
OnMotionDetected ( |
Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller. |
|
|
OnMouseButtonDoubleClick ( |
Called by Slate when the mouse wheel is used inside the viewport |
|
|
OnMouseButtonDown ( |
Called by Slate when a mouse button is pressed inside the viewport |
|
|
OnMouseButtonUp ( |
Called by Slate when a mouse button is released inside the viewport |
|
|
OnMouseEnter ( |
||
|
OnMouseLeave ( |
||
|
OnMouseMove ( |
Called by Slate when a mouse button is released inside the viewport |
|
|
OnMouseWheel ( |
Called by Slate when the mouse wheel is used inside the viewport |
|
|
FPopupMethod... |
OnQueryPopupMethod() |
Called to figure out whether we can make new windows for popups within this viewport. |
|
OnQueryShowFocus ( |
Called to determine if we should render the focus brush. |
|
|
OnRequestWindowClose() |
Called when the top level window associated with the viewport has been requested to close. |
|
|
OnTouchEnded ( |
Called when a touchpad touch is ended (finger lifted) |
|
|
OnTouchFirstMove ( |
Called when a touchpad touch has first moved after initial press |
|
|
OnTouchForceChanged ( |
Called when a touchpad touch force changes, but may or may not have moved |
|
|
OnTouchGesture ( |
Called on a touchpad gesture event |
|
|
OnTouchMoved ( |
Called when a touchpad touch is moved (finger moved) |
|
|
OnTouchStarted ( |
Called when a touchpad touch is started (finger down) |
|
|
OnViewportActivated ( |
Called when the viewports top level window is being Activated |
|
|
OnViewportClosed() |
Called when the viewport has been requested to close. |
|
|
OnViewportDeactivated ( |
Called when the viewports top level window is being Deactivated |
|
|
RequiresVsync() |
Returns true if the viewport should be vsynced. |
|
|
Tick ( |
Ticks the viewport |
Name | Description | ||
---|---|---|---|
|
FSlateShader... |
GetViewportRenderTargetTexture() |
Name | Description | ||
---|---|---|---|
|
ResizeFrame ( |
The version of FSceneViewport::ResizeFrame that takes a position is deprecated (the position was never used). Please use the version that doesn't take a position instead. |