Kōtuku
  • Gallery
  • API
  • Wiki
  • GitHub
    • Audio
    • Config
    • Core
    • Display
    • Document
    • Font
    • HTTP
    • Network
    • Regex
    • SVG
    • Tiri
    • Vector
    • XML
    • XQuery
    • XRandR
      • Audio
      • MP3
      • Sound
      • File
      • MetaClass
      • Module
      • StorageDevice
      • Task
      • Thread
      • Time
      • Compression
      • CompressedStream
      • Config
      • LZMAStream
      • Script
      • Tiri
      • XML
      • XQuery
      • Controller
      • BlurFX
      • ColourFX
      • CompositeFX
      • ConvolveFX
      • DisplacementFX
      • FilterEffect
      • FloodFX
      • ImageFX
      • LightingFX
      • MergeFX
      • MorphologyFX
      • OffsetFX
      • RemapFX
      • SourceFX
      • TurbulenceFX
      • WaveFunctionFX
      • Scintilla
      • Bitmap
      • Clipboard
      • Display
      • Document
      • Font
      • Image
      • Pointer
      • Surface
      • SVG
      • ClientSocket
      • HTTP
      • NetClient
      • NetLookup
      • NetServer
      • NetSocket
      • Proxy
      • Gradient
      • GradientConic
      • GradientContour
      • GradientDiamond
      • GradientDiffusion
      • GradientDistal
      • GradientGouraud
      • GradientLinear
      • GradientMesh
      • GradientRadial
      • GradientVoronoi
      • Vector
      • VectorClip
      • VectorColour
      • VectorEllipse
      • VectorFilter
      • VectorGradient
      • VectorGroup
      • VectorImage
      • VectorPath
      • VectorPattern
      • VectorPolygon
      • VectorRectangle
      • VectorScene
      • VectorShape
      • VectorSpiral
      • VectorText
      • VectorTransition
      • VectorViewport
      • VectorWave
      • Linux Builds
      • Windows Builds
      • Customising Your Build
      • Kōtuku Objects
      • Kōtuku In Depth
      • Kōtuku Design Patterns
      • Coding With AI
      • Regex Manual
      • XML Comparisons
      • Tiri Reference Manual
      • Config API
      • Defer Syntax
      • GUI API
      • HTTP Server API
      • I/O API
      • JSON API
      • OAuth API
      • Options API
      • Proxy Server API
      • Tempus API
      • URL API
      • VFX API
      • Widgets
      • RIPL Reference Manual
      • Origo
      • Flute / Unit Testing
      • Tuku
      • Embedded Document Format
      • TDL Reference Manual
      • TDL Tools
      • Action Reference Manual
      • System Error Codes

GradientRadial Class

Radial colour gradient paint server.

GradientRadial draws a colour ramp from a centre point to a radius. Optional focal coordinates and a focal radius support displaced radial gradients.

Structure

The GradientRadial class consists of the following fields:

Access
NameTypeComment
 CXUNITThe horizontal centre point of the gradient.

The (CX, CY) coordinates define the centre point of the radial gradient. By default, the centre point is set to 50%.

 CYUNITThe vertical centre point of the gradient.

The (CX, CY) coordinates define the centre point of the radial gradient. By default, the centre point is set to 50%.

 ContainFocalINTConfines the focal point to the base radius.

When enabled, the focal point is constrained so that it remains within the base radial gradient circle.

 FXUNITThe horizontal focal point for radial gradients.

The (FX, FY) coordinates define the focal point for radial gradients. If left undefined, the focal point will match the centre of the gradient.

 FYUNITThe vertical focal point for radial gradients.

The (FX, FY) coordinates define the focal point for radial gradients. If left undefined, the focal point will match the centre of the gradient.

 FocalRadiusUNITThe size of the focal radius for radial gradients.

If a radial gradient has a defined focal point by setting FX and FY, the FocalRadius can adjust the size of the focal area. The default of zero ensures that the focal area matches that defined by Radius.

 RadiusUNITThe radius of the gradient.

The radius of the gradient can be defined as a fixed unit or scaled relative to its container. A default radius of 50% applies if this field is not set.

 XMLDefSTRINGReturns an SVG compliant XML string that describes the effect.
GradientRadial class documentation © Paul Manias © 2010-2026