StyleBoxFlat

Customizable Stylebox with a given set of parameters. (no texture required)

This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: - Color - Border width (individual width for each border) - Rounded corners (individual radius for each corner) - Shadow About corner radius: Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example:

More...
@GodotBaseClass
struct StyleBoxFlat {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Functions

getAaSize
long getAaSize()
getBgColor
Color getBgColor()
getBorderBlend
bool getBorderBlend()
getBorderColor
Color getBorderColor()
getBorderWidth
long getBorderWidth(long margin)
getBorderWidthMin
long getBorderWidthMin()
getCornerDetail
long getCornerDetail()
getCornerRadius
long getCornerRadius(long corner)
getExpandMargin
double getExpandMargin(long margin)
getShadowColor
Color getShadowColor()
getShadowSize
long getShadowSize()
isAntiAliased
bool isAntiAliased()
isDrawCenterEnabled
bool isDrawCenterEnabled()
opAssign
StyleBoxFlat opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(StyleBoxFlat other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setAaSize
void setAaSize(long size)
setAntiAliased
void setAntiAliased(bool anti_aliased)
setBgColor
void setBgColor(Color color)
setBorderBlend
void setBorderBlend(bool blend)
setBorderColor
void setBorderColor(Color color)
setBorderWidth
void setBorderWidth(long margin, long width)
setBorderWidthAll
void setBorderWidthAll(long width)
setCornerDetail
void setCornerDetail(long detail)
setCornerRadius
void setCornerRadius(long corner, long radius)
setCornerRadiusAll
void setCornerRadiusAll(long radius)
setCornerRadiusIndividual
void setCornerRadiusIndividual(long radius_top_left, long radius_top_right, long radius_bottom_right, long radius_bottom_left)
setDrawCenter
void setDrawCenter(bool draw_center)
setExpandMargin
void setExpandMargin(long margin, double size)
setExpandMarginAll
void setExpandMarginAll(double size)
setExpandMarginIndividual
void setExpandMarginIndividual(double size_left, double size_top, double size_right, double size_bottom)
setShadowColor
void setShadowColor(Color color)
setShadowSize
void setShadowSize(long size)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

antiAliasing
bool antiAliasing [@property setter]

Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners.

antiAliasing
bool antiAliasing [@property getter]

Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners.

antiAliasingSize
long antiAliasingSize [@property getter]
long antiAliasingSize [@property setter]

This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.

bgColor
Color bgColor [@property getter]
Color bgColor [@property setter]

The background color of the stylebox.

borderBlend
bool borderBlend [@property getter]
bool borderBlend [@property setter]

When set to true, the border will fade into the background color.

borderColor
Color borderColor [@property getter]
Color borderColor [@property setter]

Sets the color of the border.

borderWidthBottom
long borderWidthBottom [@property getter]
long borderWidthBottom [@property setter]

Border width for the bottom border.

borderWidthLeft
long borderWidthLeft [@property getter]
long borderWidthLeft [@property setter]

Border width for the left border.

borderWidthRight
long borderWidthRight [@property getter]
long borderWidthRight [@property setter]

Border width for the right border.

borderWidthTop
long borderWidthTop [@property getter]
long borderWidthTop [@property setter]

Border width for the top border.

cornerDetail
long cornerDetail [@property getter]
long cornerDetail [@property setter]

This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius (setCornerRadius) into account. For corner radius smaller than 10: 4-5 should be enough For corner radius smaller than 30: 8-12 should be enough ...

cornerRadiusBottomLeft
long cornerRadiusBottomLeft [@property getter]
long cornerRadiusBottomLeft [@property setter]

The corner radius of the bottom left corner. When set to 0 the corner is not rounded.

cornerRadiusBottomRight
long cornerRadiusBottomRight [@property getter]
long cornerRadiusBottomRight [@property setter]

The corner radius of the bottom right corner. When set to 0 the corner is not rounded.

cornerRadiusTopLeft
long cornerRadiusTopLeft [@property getter]
long cornerRadiusTopLeft [@property setter]

The corner radius of the top left corner. When set to 0 the corner is not rounded.

cornerRadiusTopRight
long cornerRadiusTopRight [@property getter]
long cornerRadiusTopRight [@property setter]

The corner radius of the top right corner. When set to 0 the corner is not rounded.

drawCenter
bool drawCenter [@property getter]
bool drawCenter [@property setter]

Toggels drawing of the inner part of the stylebox.

expandMarginBottom
double expandMarginBottom [@property getter]
double expandMarginBottom [@property setter]

Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect.

expandMarginLeft
double expandMarginLeft [@property getter]
double expandMarginLeft [@property setter]

Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect.

expandMarginRight
double expandMarginRight [@property getter]
double expandMarginRight [@property setter]

Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect.

expandMarginTop
double expandMarginTop [@property getter]
double expandMarginTop [@property setter]

Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect.

shadowColor
Color shadowColor [@property getter]
Color shadowColor [@property setter]

The color of the shadow. (This has no effect when shadow_size < 1)

shadowSize
long shadowSize [@property getter]
long shadowSize [@property setter]

The shadow size in pixels.

Static functions

_new
StyleBoxFlat _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Detailed Description

height = 30 corner_radius_top_left = 50 corner_radius_bottom_left = 100

The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will never be more than the height. Result:

corner radius top left

10

corner radius bottom left

20

Meta