Navigation
API > API/Plugins > API/Plugins/AudioWidgets
Represents the appearance of an SAudioMeter
| Name | FAudioMeterStyle |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMeterStyle.h |
| Include Path | #include "AudioMeterStyle.h" |
Syntax
USTRUCT (BlueprintType )
struct FAudioMeterStyle : public FSlateWidgetStyle
Inheritance Hierarchy
- FSlateWidgetStyle → FAudioMeterStyle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioMeterStyle() |
AudioMeterStyle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAudioMeterStyle() |
AudioMeterStyle.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeName | const FName | AudioMeterStyle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundImage | FSlateBrush | Image to use to represent the background. | AudioMeterStyle.h |
|
| bScaleSide | bool | Which side to show the scale. If vertical, true means left side, false means right side. If horizontal, true means above, false means below. | AudioMeterStyle.h |
|
| bShowScale | bool | Whether or not to show the decibel scale alongside the meter. | AudioMeterStyle.h |
|
| DecibelsPerHash | int32 | How wide to draw the decibel scale, if it's enabled. | AudioMeterStyle.h |
|
| Font | FSlateFontInfo | Font family and size to be used when displaying the meter scale. | AudioMeterStyle.h |
|
| MeterBackgroundImage | FSlateBrush | Image to use to represent the meter background. | AudioMeterStyle.h |
|
| MeterPadding | FVector2D | How much padding to add around the meter. | AudioMeterStyle.h |
|
| MeterPeakImage | FSlateBrush | Image to use to represent the meter peak. | AudioMeterStyle.h |
|
| MeterSize | FVector2D | How thick to draw the meter. | AudioMeterStyle.h |
|
| MeterValueBackgroundImage | FSlateBrush | Image to use to draw behind the meter value. | AudioMeterStyle.h |
|
| MeterValueImage | FSlateBrush | Image to use to represent the meter value. | AudioMeterStyle.h |
|
| MeterValuePadding | float | How much padding to add around the meter value. | AudioMeterStyle.h |
|
| PeakValueWidth | float | How wide to draw the peak value indicator. | AudioMeterStyle.h |
|
| ScaleHashHeight | float | The height of each hash mark. | AudioMeterStyle.h |
|
| ScaleHashOffset | float | Offset for the hashes. | AudioMeterStyle.h |
|
| ScaleHashWidth | float | The width of each hash mark. | AudioMeterStyle.h |
|
| ValueRangeDb | FVector2D | The minimum and maximum value to display in dB (values are clamped in this range) | AudioMeterStyle.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioMeterStyle & SetBackgroundImage
(
const FSlateBrush& InBackgroundImage |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetDecibelsPerHash
(
float InDecibelsPerHash |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const FName& InFontName, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const FSlateFontInfo& InFont |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const UObject* InFontObject, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
TSharedPtr< const FCompositeFont > InCompositeFont, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const ANSICHAR* InFontName, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const WIDECHAR* InFontName, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFont
(
const FString& InFontName, |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFontName
(
const FName& InFontName |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFontName
(
const FString& InFontName |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFontName
(
const WIDECHAR* InFontName |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFontName
(
const ANSICHAR* InFontName |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetFontSize
(
uint16 InSize |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterBackgroundImage
(
const FSlateBrush& InMeterBackgroundImage |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterPadding
(
const FVector2D& InMeterPadding |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterPeakImage
(
const FSlateBrush& InMeterPeakImage |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterSize
(
const FVector2D& InMeterSize |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterValueBackgroundImage
(
const FSlateBrush& InMeterValueBackgroundImage |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterValueImage
(
const FSlateBrush& InMeterValueImage |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetMeterValuePadding
(
float InMeterValuePadding |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetPeakValueWidth
(
float InPeakValueWidth |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetScaleHashHeight
(
float InScaleHashHeight |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetScaleHashOffset
(
float InScaleHashOffset |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetScaleHashWidth
(
float InScaleHashWidth |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetScaleSide
(
bool bInScaleSide |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetShowScale
(
bool bInShowScale |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetTypefaceFontName
(
const FName& InTypefaceFontName |
AudioMeterStyle.h | ||
FAudioMeterStyle & SetValueRangeDb
(
const FVector2D& InValueRangeDb |
AudioMeterStyle.h | ||
void UnlinkColors () |
Unlinks all colors in this style. | AudioMeterStyle.h |
Overridden from FSlateWidgetStyle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetResources
(
TArray< const FSlateBrush* >& OutBrushes |
AudioMeterStyle.h | ||
virtual const FName GetTypeName() |
AudioMeterStyle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FAudioMeterStyle & GetDefault() |
AudioMeterStyle.h |