className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
STimeline::ComputeDesiredSize | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size. | ProfileVisualizer | virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const | [] |
STimeline::Construct | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Construct the widget | ProfileVisualizer | void Construct ( const [FArguments](API\Developer\ProfileVisualizer\STimeline\FArguments) & InArgs ) | [] |
STimeline::FArguments::FixedLabelSpacing | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Fixed pixel spacing between centers of labels | ProfileVisualizer | WidgetArgsType & FixedLabelSpacing &40; float InArg &41; | [] |
STimeline::FArguments::MaxValue | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Maximum value on the timeline | ProfileVisualizer | WidgetArgsType & MaxValue &40; float InArg &41; | [] |
STimeline::FArguments::MinValue | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Minimum value on the timeline | ProfileVisualizer | WidgetArgsType & MinValue &40; float InArg &41; | [] |
WidgetArgsType | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | typedef FArguments WidgetArgsType | [] |
|
STimeline::FArguments::FArguments | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | FArguments&40;&41; | [] |
|
FArguments | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | struct FArguments : public [TSlateBaseNamedArgs< STimeline >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs) | [] |
|
STimeline::GetDrawingGeometry | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) GetDrawingGeometry() const | [] |
|
STimeline::GetMinMaxValues | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | void GetMinMaxValues ( float & InMin, float & InMax ) | [] |
|
STimeline::GetOffset | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Gets the graph's offset value
Offset value | ProfileVisualizer | float GetOffset() const | [] |
STimeline::OnMouseButtonDown | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action. | ProfileVisualizer | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
STimeline::GetZoom | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | float GetZoom() | [] |
|
STimeline::OnMouseMove | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action. | ProfileVisualizer | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
STimeline::OnPaint | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
The maximum layer ID attained by this widget or any of its children. | ProfileVisualizer | virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const | [] |
STimeline::SetMinMaxValues | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Sets the graph's min and max values. | ProfileVisualizer | void SetMinMaxValues ( float InMin, float InMax ) | [] |
STimeline::SetDrawingGeometry | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | ProfileVisualizer | void SetDrawingGeometry ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & Geometry ) | [] |
|
STimeline::SetOffset | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Sets the graph's offset by which all graph bars should be moved | ProfileVisualizer | void SetOffset ( float InOffset ) | [] |
STimeline::SetZoom | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Sets the graph's zoom level | ProfileVisualizer | void SetZoom ( float InZoom ) | [] |
STimeline::Tick | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation. | ProfileVisualizer | virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) | [] |
STimeline | /Engine/Source/Developer/ProfileVisualizer/Public/STimeline.h | A timeline widget. | ProfileVisualizer | class STimeline : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget) | [] |
Type | /Engine/Source/Developer/ProfileVisualizer/Public/VisualizerEvents.h | ProfileVisualizer | typedef uint8 Type | [] |
|
Type | /Engine/Source/Developer/ProfileVisualizer/Public/VisualizerEvents.h | ProfileVisualizer | typedef uint8 Type | [] |
|
IProjectLauncherModule::~IProjectLauncherModule | /Engine/Source/Developer/ProjectLauncher/Public/IProjectLauncherModule.h | Virtual destructor. | ProjectLauncher | virtual ~IProjectLauncherModule() | [] |
IProjectLauncherModule | /Engine/Source/Developer/ProjectLauncher/Public/IProjectLauncherModule.h | Interface for launcher UI modules. | ProjectLauncher | class IProjectLauncherModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
IScreenShotComparisonModule::CreateScreenShotComparison | /Engine/Source/Developer/ScreenShotComparison/Public/Interfaces/IScreenShotComparisonModule.h | Creates a screen shot comparison widget.
The new widget | ScreenShotComparison | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateScreenShotComparison ( const [IScreenShotManagerRef](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManagerRef) & InScreenShotManager ) | [] |
IScreenShotComparisonModule::~IScreenShotComparisonModule | /Engine/Source/Developer/ScreenShotComparison/Public/Interfaces/IScreenShotComparisonModule.h | Virtual destructor. | ScreenShotComparison | virtual ~IScreenShotComparisonModule() | [] |
IScreenShotComparisonModule | /Engine/Source/Developer/ScreenShotComparison/Public/Interfaces/IScreenShotComparisonModule.h | Interface for screen shot comparison UI modules. | ScreenShotComparison | class IScreenShotComparisonModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
FComparableImage::CanGetPixel | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | bool CanGetPixel ( int32 X, int32 Y ) const | [] |
|
FComparableImage::GetPixel | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | [FColor](API\Runtime\Core\Math\FColor) GetPixel ( int32 X, int32 Y ) const | [] |
|
FComparableImage::LoadCompressedData | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Populate image by loading compressed data
true if success | ScreenShotComparisonTools | bool LoadCompressedData ( const void * CompressedData, int64 CompressedSize, const [FString](API\Runtime\Core\Containers\FString) & ImageExtension, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) | [] |
FComparableImage::LoadFile | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Populate image by loading an file
true if success | ScreenShotComparisonTools | bool LoadFile ( const [FString](API\Runtime\Core\Containers\FString) & ImagePath, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) | [] |
FComparableImage::FComparableImage | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | FComparableImage() | [] |
|
FComparableImage | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | class FComparableImage | [
{
"type": "TArray64< uint8...",
"name": "Bytes",
"description": ""
},
{
"type": "int32",
"name": "Height",
"description": ""
},
{
"type": "int32",
"name": "Width",
"description": ""
}
] |
|
FComparisonReport::GetReportFile | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Return the path to the file used to generate this report | ScreenShotComparisonTools | const [FString](API\Runtime\Core\Containers\FString) & GetReportFile() const | [] |
FComparisonReport::GetComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | const [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) & GetComparisonResult() const | [] |
|
FComparisonReport::GetReportPath | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Return the path to all files in this report | ScreenShotComparisonTools | const [FString](API\Runtime\Core\Containers\FString) & GetReportPath() const | [] |
FComparisonReport::GetReportRootDirectory | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Return the path to a location where all reports (including this one) are kept in this session | ScreenShotComparisonTools | const [FString](API\Runtime\Core\Containers\FString) & GetReportRootDirectory() const | [] |
FComparisonReport::SetComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | void SetComparisonResult ( const [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) & InResult ) | [] |
|
FComparisonReport::FComparisonReport | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ReportRootDirectory is where all reports are saved. E.g./Saved/Automation/Reports ReportFile is a specific report for a test under this path. E.g./Saved/Automation/Reports/Test/TestName/report.json. | ScreenShotComparisonTools | FComparisonReport ( const [FString](API\Runtime\Core\Containers\FString) & InReportRootDirectory, const [FString](API\Runtime\Core\Containers\FString) & InReportFile ) | [] |
FComparisonReport | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | struct FComparisonReport | [] |
|
FImageComparer::Compare | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) Compare ( const [FString](API\Runtime\Core\Containers\FString) & ImagePathA, const [FString](API\Runtime\Core\Containers\FString) & ImagePathB, [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) Tolerance, const [FString](API\Runtime\Core\Containers\FString) & OutDeltaPath ) | [] |
|
FImageComparer::Compare | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) Compare ( const [FComparableImage](API\Developer\ScreenShotComparisonTools\FComparableImage) * ImageA, const [FComparableImage](API\Developer\ScreenShotComparisonTools\FComparableImage) * ImageB, [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) Tolerance, const [FString](API\Runtime\Core\Containers\FString) & OutDeltaPath ) | [] |
|
FImageComparer::CompareStructuralSimilarity | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | https://en.wikipedia.org/wiki/Structural_similarity | ScreenShotComparisonTools | double CompareStructuralSimilarity ( const [FString](API\Runtime\Core\Containers\FString) & ImagePathA, const [FString](API\Runtime\Core\Containers\FString) & ImagePathB, [EStructuralSimilarityComponent](API\Developer\ScreenShotComparisonTools\FImageComparer\EStructuralSimil-) InCompareComponent, const [FString](API\Runtime\Core\Containers\FString) & OutDeltaPath ) | [] |
FImageComparer::CompareStructuralSimilarity | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | https://en.wikipedia.org/wiki/Structural_similarity | ScreenShotComparisonTools | double CompareStructuralSimilarity ( const [FComparableImage](API\Developer\ScreenShotComparisonTools\FComparableImage) * ImageA, const [FComparableImage](API\Developer\ScreenShotComparisonTools\FComparableImage) * ImageB, [EStructuralSimilarityComponent](API\Developer\ScreenShotComparisonTools\FImageComparer\EStructuralSimil-) InCompareComponent, const [FString](API\Runtime\Core\Containers\FString) & OutDeltaPath ) | [] |
EStructuralSimilarityComponent | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | enum EStructuralSimilarityComponent { Luminance, Color, } | [] |
|
FImageComparer | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | class FImageComparer | [] |
|
FImageComparisonResult::AreSimilar | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Returns true if the images were within the provided tolerance values | ScreenShotComparisonTools | bool AreSimilar() const | [] |
CurrentVersion | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static constexpr int32 CurrentVersion = 2; | [] |
|
FImageComparisonResult::IsIdeal | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Returns true if this is am ideal comparison (e.g not using a fallback for comparison) | ScreenShotComparisonTools | bool IsIdeal() const | [] |
FImageComparisonResult::IsNew | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Returns true if this is a new image with no approved file to compare against | ScreenShotComparisonTools | bool IsNew() const | [] |
FImageComparisonResult::IsValid | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Returns true if this is a new image with no approved file to compare against | ScreenShotComparisonTools | bool IsValid() const | [] |
FImageComparisonResult::SetInvalid | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | Marks this struct as invalid. Can be used before serializing in to ensure very old files with no version info aren't recognized. | ScreenShotComparisonTools | void SetInvalid() | [] |
FImageComparisonResult::FImageComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | FImageComparisonResult() | [] |
|
FImageComparisonResult::FImageComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | FImageComparisonResult ( const [FText](API\Runtime\Core\Internationalization\FText) & Error ) | [] |
|
FImageComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | All paths in this structure should be portable. Test results (including this struct) result can be serialized to JSON and stored on the network as during automation runs then opened in the editor to commit / approve changes to the local project. | ScreenShotComparisonTools | struct FImageComparisonResult | [
{
"type": "FString",
"name": "ApprovedFilePath",
"description": "Path to the file that was considered as the ground-truth. Relative to the project directory"
},
{
"type": "FString",
"name": "ComparisonFilePath",
"description": "Path to the delta image between the ground-truth and the incoming file."
},
{
"type": "FDateTime",
"name": "CreationTime",
"description": "Time that the comparison was performed"
},
{
"type": "FText",
"name": "ErrorMessage",
"description": "Error message that can be set during a comparison"
},
{
"type": "double",
"name": "GlobalDifference",
"description": "Global difference found during comparison"
},
{
"type": "FString",
"name": "IdealApprovedFolderPath",
"description": "Path to a folder where the idealized ground-truth for this comparison would be."
},
{
"type": "FString",
"name": "IncomingFilePath",
"description": "Path to the file that was generated in the test."
},
{
"type": "double",
"name": "MaxLocalDifference",
"description": "Largest local difference found during comparison"
},
{
"type": "FString",
"name": "ReportApprovedFilePath",
"description": "Name of the approved file saved for the report."
},
{
"type": "FString",
"name": "ReportComparisonFilePath",
"description": "Name of the delta image saved for the report."
},
{
"type": "FString",
"name": "ReportIncomingFilePath",
"description": "Name of the incoming file saved for the report."
},
{
"type": "FString",
"name": "SourcePlatform",
"description": "Platform that the incoming image was generated on"
},
{
"type": "FString",
"name": "SourceRHI",
"description": "RHI that the incoming image was generated with"
},
{
"type": "FImageTolerance",
"name": "Tolerance",
"description": "Tolerance values for comparison"
},
{
"type": "int32",
"name": "Version",
"description": "Version of the image comparision result"
}
] |
DefaultIgnoreAntiAliasing | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) DefaultIgnoreAntiAliasing; | [] |
|
DefaultIgnoreColors | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) DefaultIgnoreColors; | [] |
|
DefaultIgnoreNothing | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) DefaultIgnoreNothing; | [] |
|
DefaultIgnoreLess | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) DefaultIgnoreLess; | [] |
|
FImageTolerance::FImageTolerance | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | FImageTolerance ( uint8 R, uint8 G, uint8 B, uint8 A, uint8 InMinBrightness, uint8 InMaxBrightness, bool InIgnoreAntiAliasing, bool InIgnoreColors, float InMaximumLocalError, float InMaximumGlobalError ) | [] |
|
FImageTolerance::FImageTolerance | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | FImageTolerance() | [] |
|
FImageTolerance | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | struct FImageTolerance | [
{
"type": "uint8",
"name": "Alpha",
"description": ""
},
{
"type": "uint8",
"name": "Blue",
"description": ""
},
{
"type": "uint8",
"name": "Green",
"description": ""
},
{
"type": "bool",
"name": "IgnoreAntiAliasing",
"description": ""
},
{
"type": "bool",
"name": "IgnoreColors",
"description": ""
},
{
"type": "uint8",
"name": "MaxBrightness",
"description": ""
},
{
"type": "float",
"name": "MaximumGlobalError",
"description": ""
},
{
"type": "float",
"name": "MaximumLocalError",
"description": ""
},
{
"type": "uint8",
"name": "MinBrightness",
"description": ""
},
{
"type": "uint8",
"name": "Red",
"description": ""
}
] |
|
FPixelOperations::GetHue | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static float GetHue ( const [FColor](API\Runtime\Core\Math\FColor) & Color ) | [] |
|
FPixelOperations::GetLuminance | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static double GetLuminance ( const [FColor](API\Runtime\Core\Math\FColor) & Color ) | [] |
|
FPixelOperations::IsAntialiased | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static bool IsAntialiased ( const [FColor](API\Runtime\Core\Math\FColor) & SourcePixel, const [FComparableImage](API\Developer\ScreenShotComparisonTools\FComparableImage) * Image, int32 X, int32 Y, const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) & Tolerance ) | [] |
|
FPixelOperations::IsBrightnessSimilar | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static bool IsBrightnessSimilar ( const [FColor](API\Runtime\Core\Math\FColor) & ColorA, const [FColor](API\Runtime\Core\Math\FColor) & ColorB, const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) & Tolerance ) | [] |
|
FPixelOperations::IsContrasting | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static bool IsContrasting ( const [FColor](API\Runtime\Core\Math\FColor) & ColorA, const [FColor](API\Runtime\Core\Math\FColor) & ColorB, const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) & Tolerance ) | [] |
|
FPixelOperations::IsRGBSame | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static bool IsRGBSame ( const [FColor](API\Runtime\Core\Math\FColor) & ColorA, const [FColor](API\Runtime\Core\Math\FColor) & ColorB ) | [] |
|
FPixelOperations::IsRGBSimilar | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | static bool IsRGBSimilar ( const [FColor](API\Runtime\Core\Math\FColor) & ColorA, const [FColor](API\Runtime\Core\Math\FColor) & ColorB, const [FImageTolerance](API\Developer\ScreenShotComparisonTools\FImageTolerance) & Tolerance ) | [] |
|
FPixelOperations | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ImageComparer.h | ScreenShotComparisonTools | class FPixelOperations | [] |
|
FScreenshotFallbackEntry | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Holds settings for screenshot fallbacks | ScreenShotComparisonTools | struct FScreenshotFallbackEntry | [
{
"type": "FString",
"name": "Child",
"description": ""
},
{
"type": "FString",
"name": "Parent",
"description": ""
}
] |
FScreenshotFallbackEntry::operator== | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | ScreenShotComparisonTools | bool operator== ( const [FScreenshotFallbackEntry](API\Developer\ScreenShotComparisonTools\FScreenshotFallbackEntry) & Other ) const | [] |
|
GetTypeHash | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | ScreenShotComparisonTools | uint32 GetTypeHash ( const [FScreenshotFallbackEntry](API\Developer\ScreenShotComparisonTools\FScreenshotFallbackEntry) & Object ) | [] |
|
EScreenShotCompareOptions | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Describes options available when comparing screenshots | ScreenShotComparisonTools | enum EScreenShotCompareOptions { None, DiscardImage, KeepImage, } | [] |
FScreenshotExportResult::FScreenshotExportResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | ScreenShotComparisonTools | FScreenshotExportResult() | [] |
|
FScreenshotExportResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | ScreenShotComparisonTools | struct FScreenshotExportResult | [
{
"type": "FString",
"name": "ExportPath",
"description": ""
},
{
"type": "bool",
"name": "Success",
"description": ""
}
] |
|
IScreenShotManager::CompareScreenshotAsync | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.TFuture | ScreenShotComparisonTools | [TFuture](API\Runtime\Core\Async\TFuture)< [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) > CompareScreenshotAsync ( const [FString](API\Runtime\Core\Containers\FString) & IncomingPath, const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & MetaData, const [EScreenShotCompareOptions](API\Developer\ScreenShotComparisonTools\Interfaces\EScreenShotCompareOptions) Options ) | [] |
IScreenShotManager::ExportScreenshotComparisonResult | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Exports target screenshot report to the export location specified | ScreenShotComparisonTools | [FScreenshotExportResult](API\Developer\ScreenShotComparisonTools\Interfaces\FScreenshotExportResult) ExportScreenshotComparisonResult ( [FString](API\Runtime\Core\Containers\FString) ScreenshotName, [FString](API\Runtime\Core\Containers\FString) ExportPath, bool bOnlyIncoming ) | [] |
IScreenShotManager::GetIdealApprovedFolderForImage | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Calculate the ideal path for already already approved (ground truth) images. This handles abstracting away where Ground Truth images should be saved based on the platform/rhi/etc. | ScreenShotComparisonTools | [FString](API\Runtime\Core\Containers\FString) GetIdealApprovedFolderForImage ( const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & MetaData ) const | [] |
IScreenShotManager::OpenComparisonReports | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Imports screenshot comparison data from a given path. | ScreenShotComparisonTools | bool OpenComparisonReports ( [FString](API\Runtime\Core\Containers\FString) ImportPath, [TArray](API\Runtime\Core\Containers\TArray)< [FComparisonReport](API\Developer\ScreenShotComparisonTools\FComparisonReport) > & OutReports ) | [] |
IScreenShotManager::~IScreenShotManager | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | ScreenShotComparisonTools | virtual ~IScreenShotManager() | [] |
|
IScreenShotManager | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Interface that defines a class which is capable of comparing screenshots at a provided path with checked in ground truth versions and generate results and reports. | ScreenShotComparisonTools | class IScreenShotManager | [] |
IScreenShotManagerPtr | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Type definition for shared pointers to instances ofIScreenShotManager. | ScreenShotComparisonTools | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IScreenShotManager](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManager) > IScreenShotManagerPtr | [] |
IScreenShotManagerRef | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotManager.h | Type definition for shared references to instances ofIScreenShotManager. | ScreenShotComparisonTools | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IScreenShotManager](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManager) > IScreenShotManagerRef | [] |
IScreenShotToolsModule::GetScreenShotManager | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotToolsModule.h | Get the session manager.
The session manager. | ScreenShotComparisonTools | [IScreenShotManagerPtr](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManagerPtr) GetScreenShotManager() | [] |
IScreenShotToolsModule::~IScreenShotToolsModule | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotToolsModule.h | Virtual destructor. | ScreenShotComparisonTools | virtual ~IScreenShotToolsModule() | [] |
IScreenShotToolsModule | /Engine/Source/Developer/ScreenShotComparisonTools/Public/Interfaces/IScreenShotToolsModule.h | Interface for session core modules. | ScreenShotComparisonTools | class IScreenShotToolsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
UScreenShotComparisonSettings::Create | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Creates class instance | ScreenShotComparisonTools | static [UScreenShotComparisonSettings](API\Developer\ScreenShotComparisonTools\UScreenShotComparisonSettings) * Create ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName ) | [] |
UScreenShotComparisonSettings::GetAllPlatformSettings | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | ScreenShotComparisonTools | static const [TSet](API\Runtime\Core\Containers\TSet)< [FScreenshotFallbackEntry](API\Developer\ScreenShotComparisonTools\FScreenshotFallbackEntry) > & GetAllPlatformSettings() | [] |
|
UScreenShotComparisonSettings::GetPlatformName | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Returns platform name reference. As the class can store platform-independent config, it returns an empty string if the platform was not specified. | ScreenShotComparisonTools | virtual const [FString](API\Runtime\Core\Containers\FString) & GetPlatformName() const | [] |
UScreenShotComparisonSettings::GetConfigOverridePlatform | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Overrides config hierarchy platform to be used inUObjectinternals | ScreenShotComparisonTools | virtual const TCHAR * GetConfigOverridePlatform() const | [] |
UScreenShotComparisonSettings::LoadSettings | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Loads settings of corresponding config. | ScreenShotComparisonTools | virtual void LoadSettings() | [] |
UScreenShotComparisonSettings::SetPlatform | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | Sets platform and reloads settings. | ScreenShotComparisonTools | virtual void SetPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName ) | [] |
UScreenShotComparisonSettings::UScreenShotComparisonSettings | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | ScreenShotComparisonTools | UScreenShotComparisonSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | [] |
|
UScreenShotComparisonSettings | /Engine/Source/Developer/ScreenShotComparisonTools/Public/ScreenShotComparisonSettings.h | ScreenShotComparisonTools | class UScreenShotComparisonSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject) | [
{
"type": "bool",
"name": "bUseConfidentialPlatformPathsForSavedResults",
"description": "If true, any checked-in test results for confidential platforms will be put under/Platforms//Test instead of/Test"
},
{
"type": "TArray<FScreen...",
"name": "ScreenshotFallbackPlatforms",
"description": "An array of entries that describe other platforms we can use for fallbacks when comparing screenshots"
}
] |
|
FKismetBytecodeDisassembler::DisassembleAllFunctionsInClasses | /Engine/Source/Developer/ScriptDisassembler/Public/ScriptDisassembler.h | Disassemble all functions in any classes that have matching names. | ScriptDisassembler | static void DisassembleAllFunctionsInClasses ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, const [FString](API\Runtime\Core\Containers\FString) & ClassnameSubstring ) | [] |
FKismetBytecodeDisassembler::DisassembleStructure | /Engine/Source/Developer/ScriptDisassembler/Public/ScriptDisassembler.h | Disassemble all of the script code in a single structure. | ScriptDisassembler | void DisassembleStructure ( [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * Source ) | [] |
FKismetBytecodeDisassembler::FKismetBytecodeDisassembler | /Engine/Source/Developer/ScriptDisassembler/Public/ScriptDisassembler.h | Construct a disassembler that will output to the specified archive. | ScriptDisassembler | FKismetBytecodeDisassembler ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & InAr ) | [] |
FKismetBytecodeDisassembler | /Engine/Source/Developer/ScriptDisassembler/Public/ScriptDisassembler.h | Kismet bytecode disassembler; Can be used to create a human readable version of Kismet bytecode for a specified structure or class. | ScriptDisassembler | class FKismetBytecodeDisassembler | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.