Navigation
API > API/Plugins > API/Plugins/ImageWidgets
Interface for a component that wants to show image related content with the Slate widgets in the ImageWidget module. In this context, and "image" is considered to be any 2D content that is contained within an axis-aligned rectangle.
| Name | IImageViewer |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ImageWidgets/Source/ImageWidgets/Public/IImageViewer.h |
| Include Path | #include "IImageViewer.h" |
Syntax
class IImageViewer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~IImageViewer() |
IImageViewer.h |
Structs
| Name | Remarks |
|---|---|
| FDrawProperties | Information necessary for correctly drawing an image. |
| FImageInfo | Information about an image to be displayed. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DrawCurrentImage
(
FViewport* Viewport, |
Draws the image that is currently supposed to be displayed within the 2D viewport. | IImageViewer.h | |
| Provides any necessary metadata for the image widgets about the image that is currently supposed to be displayed. | IImageViewer.h | ||
TOptional< TVariant< FColor, FLinearColor > > GetCurrentImagePixelColor
(
FIntPoint PixelCoords, |
Provides information about a given pixel. | IImageViewer.h | |
FText GetImageName
(
const FGuid& Guid |
Returns the name of a currently available image. | IImageViewer.h | |
bool IsValidImage
(
const FGuid& Guid |
Returns if a given GUID represents a currently available image. | IImageViewer.h | |
void OnImageSelected
(
const FGuid& Guid |
Notifies about the image with the given GUID being selected. | IImageViewer.h |