segment_set_right_pos


Description:

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

Sets the right endpoint position of the segment

Sets the right endpoint position of the segment of the gradient. The final position will be the given fraction from the midpoint of the current segment to the midpoint of the segment to the right. 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 right endpoint to.

final_pos

The return position.

Returns:

TRUE on success.