GradientSignal::GradientImageCreatorRequests Class Reference

#include <EditorGradientImageCreatorRequestBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual AZ::Vector2	GetOutputResolution () const =0
virtual void	SetOutputResolution (const AZ::Vector2 &resolution)=0
virtual OutputFormat	GetOutputFormat () const =0
virtual void	SetOutputFormat (OutputFormat outputFormat)=0
virtual AZ::IO::Path	GetOutputImagePath () const =0
virtual void	SetOutputImagePath (const AZ::IO::Path &outputImagePath)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Detailed Description

EBus that is used by any Editor Gradient components that create images (Gradient Baker, Image Gradient). It contains the common APIs needed for image creation.

Member Function Documentation

GetOutputFormat()

virtual OutputFormat GradientSignal::GradientImageCreatorRequests::GetOutputFormat ( ) const

pure virtual

Get the output format that we will create the image with.

Returns

Returns the output format.

GetOutputImagePath()

virtual AZ::IO::Path GradientSignal::GradientImageCreatorRequests::GetOutputImagePath ( ) const

pure virtual

Get the output image path (including file name) for where we'll save the created image.

Returns

The output path and file name.

GetOutputResolution()

virtual AZ::Vector2 GradientSignal::GradientImageCreatorRequests::GetOutputResolution ( ) const

pure virtual

Get the output resolution that we will create the image with.

Returns

Returns the output width, height in a Vector2

SetOutputFormat()

virtual void GradientSignal::GradientImageCreatorRequests::SetOutputFormat ( OutputFormat  outputFormat )

pure virtual

Sets the output format for creating the image.

Parameters

outputFormat

The output format to use.

SetOutputImagePath()

virtual void GradientSignal::GradientImageCreatorRequests::SetOutputImagePath ( const AZ::IO::Path &  outputImagePath )

pure virtual

Sets the output image path and file name for creating the image.

Parameters

outputImagePath

The output image path and file name to use.

SetOutputResolution()

virtual void GradientSignal::GradientImageCreatorRequests::SetOutputResolution ( const AZ::Vector2 &  resolution )

pure virtual

Sets the output resolution for creating the image.

Parameters

resolution

The width and height for the created image.

---

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

• Gems/GradientSignal/Code/Include/GradientSignal/Editor/EditorGradientImageCreatorRequestBus.h