segment_set_left_pos


Description:

[ Version ( since = "2.2" ) ]
public bool segment_set_left_pos (int segment, double pos, out double final_pos)

Sets the left endpoint position of the segment

Sets the position of the left endpoint of the segment of the gradient. The final position will be the given fraction from the midpoint to the left to the midpoint of the current segment. Returns the final position. Returns an error when gradient is not editable or segment index is out of range.

Parameters:

this

The gradient.

segment

The index of a segment within the gradient.

pos

The position to set the guidepoint to.

final_pos

The return position.

Returns:

TRUE on success.