SCE Starfield

    Print  Previous  Next

Functions Provided By SCE Starfield

Function

Description

void SetBpm(int bpm)

Sets the speed of the effect in BPM. Valid values range from 0 to 9999. Default value is 1500.

int GetBpm()

Returns the current speed of the effect in BPM.

void SetLength(int size)

Sets the length of the effect. Valid values range from 1 to 100. The default value is 20.

int GetLength()

Returns the currently set length.

void SetCount(int count)

Sets the number of objects. Valid values range from 0 to 100. The default value is 50.

int GetCount()

Returns the number of objects.

void SetWidth(int width)

Sets the size of the objects. Valid values range from 1 to 100. The default value is 10.

int GetWidth()

Returns the size of the objects.

void SetDepth(int depth)

Sets the depth effect. Valid values range from 1 to 100. The default value is 80.

int GetDepth()

Returns the currently set depth.

void SetRotation(int rotation)

Sets the amount of rotation. Valid values range from -100 to 100. The default value is 0.

int GetRotation()

Returns the currently set amount of rotation.

void SetDirection(int dir)

Sets the direction of the effect. See below for details.

int GetDirection()

Returns the currently set direction.

void SetColorMode(int mode)

Sets the color mode of the Color Table. See below for details.

int GetColorMode()

Returns the currently set color mode.

void SetShape(int shape)

Sets the shape of the objects. See below for details.

int GetShape()

Returns the currently set shape of objects.

void SetColor(int idx, color c)

Sets the color at the specified index in the Color Table dialog. If idx is out of range, nothing happens.

color GetColor(int idx)

Returns the color of the specified index in the color table. If the index is out of range, black is returned.

int GetColorCount()

Returns the number of colors in the color table.

void AddColor(int idx, color c)

Adds another color to the color table at the specified index position. If the index is lower or equal to 0, the new color is added to the first position. If the index is greater than the current number of colors, the new color is added at the end.

void RemoveColor(int idx)

Removes the color located at the specified index. If the given index is out of range, nothing happens. The Color Table of this effect needs to include at least 1 entry.

 

This Effect uses the Color Table. Learn more about Using Colors.

 

Shapes

This effect uses various geometrical figures. The function SetShape can be used to change them. The following values can be used as parameter:

Value

Description

DRAW_RECT

Selects the unfilled rectangle for drawing.

FILL_RECT

Selects the filled rectangle for drawing.

DRAW_CIRCLE

Selects the unfilled circle for drawing.

FILL_CIRCLE

Selects the filled circle for drawing.

DRAW_CROSS

Selects the cross for drawing.

DRAW_STAR

Selects the star for drawing.

DRAW_DIAMOND

Selects the unfilled diamond for drawing.

FILL_DIAMOND

Selects the filled diamond for drawing.

DRAW_RANDOM

Selects random shapes for drawing.

 

Effect Direction

The "stars" can move outwards or inwards. To set those directions, use the function SetDirection with the following values:

Value

Description

DIR_OUTWARDS

Sets direction to "outwards".

DIR_INWARDS

Sets direction to "inwards".

 

Color Modes

This effect uses various color modes. The function SetColorMode can be used to change them. The following values can be used as parameter:

Value

Description

CM_LOOP

Sets the loop mode. In this mode the effect loops through the colortable to select the colors for new shapes.

CM_SHUFFLE

Sets the shuffle mode. In this mode the effect selects the color for a new shape from the color table by random access.

CM_RANDOM

Sets the random mode. In this mode the colors for the shapes are generated by random but 10% of the colors will be generated by random access to the color table.