1. Epic GamesDeveloper
  3. FPreviewPlatformInfo

FPreviewPlatformInfo

API > API/Editor > API/Editor/UnrealEd

   
Name FPreviewPlatformInfo
Type struct
Header File /Engine/Source/Editor/UnrealEd/Classes/Editor/EditorEngine.h
Include Path #include "Editor/EditorEngine.h"

Syntax

struct FPreviewPlatformInfo

Constructors

Name Remarks Include Path Unreal Specifiers
  Editor/EditorEngine.h  

FPreviewPlatformInfo ( ERHIFeatureLevel::Type InFeatureLevel,
EShaderPlatform InShaderPlatform,
FName InPreviewPlatformName,
FName InPreviewShaderFormatName,
FName InDeviceProfileName,
bool InbPreviewFeatureLevelActive,
FName InShaderPlatformName,
FText InPreviewShaderPlatformFriendlyName,
float InConstrainedAspectRatio,
FVector4f InSafeZones
)

   Editor/EditorEngine.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bPreviewFeatureLevelActive bool Is feature level preview currently active Editor/EditorEngine.h  
DeviceProfileName FName The device profile to preview. Editor/EditorEngine.h  
PreviewFeatureLevel ERHIFeatureLevel::Type The feature level we should use when loading or creating a new world Editor/EditorEngine.h  
PreviewPlatformName FName The the platform to preview, or NAME_None if there is no preview platform Editor/EditorEngine.h  
PreviewShaderFormatName FName The shader Format to preview, or NAME_None if there is no shader preview format Editor/EditorEngine.h  
PreviewShaderPlatformName FName Preview Shader Platform Name Editor/EditorEngine.h  
ShaderPlatform EShaderPlatform The ShaderPlatform to be used when in preview Editor/EditorEngine.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ConstrainedAspectRatio float Constrained Aspect Ratio of the preview platform Editor/EditorEngine.h  
PreviewShaderPlatformFriendlyName FText Cache Preview ShaderPlatform Name Editor/EditorEngine.h  
SafeZones FVector4f Safe Zones of the preview platform Editor/EditorEngine.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetConstrainedAspectRatio()

 Return the Constrained Aspect Ratio of the preview platform Editor/EditorEngine.h  

ERHIFeatureLevel::Type GetEffectivePreviewFeatureLevel()

 Returns the preview feature level if active, or GMaxRHIFeatureLevel otherwise Editor/EditorEngine.h  

FName GetEffectivePreviewPlatformName()

 Return platform name like "Android", or NAME_None if none is set or the preview feature level is not active Editor/EditorEngine.h  

FText GetFriendlyName()

 Returns the Friendly Name of the Preview Editor/EditorEngine.h  

FVector4f GetSafeZones()

 Return the Safe Zones of the preview platform Editor/EditorEngine.h  

EShaderPlatform GetShaderPlatform()

 Returns the Shader Platform of the Preview Editor/EditorEngine.h  

bool Matches ( const FPreviewPlatformInfo& Other
) const

 Checks if two FPreviewPlatformInfos are for the same preview platform. Editor/EditorEngine.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page