Struct gegl::Random

#[repr(transparent)]
pub struct Random { /* private fields */ }

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl Random

pub fn as_ptr(&self) -> *mut GeglRandom

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GeglRandom) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut(ptr: &mut *mut GeglRandom) -> &mut Self

Borrows the underlying C value mutably.

impl Random

pub fn new() -> Random

Creates a new random number generator initialized with a random seed. This structure needs to be freed by the user with gegl_random_free();

pub fn with_seed(seed: u32) -> Random

Return an opaque structure associated to the seed. This structure needs to be freed by the user with gegl_random_free();

seed

an integer seed, change for different permutation.

pub fn duplicate(&mut self) -> Option<Random>

Return a new copy of an existing GeglRandom

pub fn float(&self, x: i32, y: i32, z: i32, n: i32) -> f32

Return a random floating point number in range 0.0 .. 1.0.

x

x coordinate

y

y coordinate

z

z coordinate (mipmap level)

n

number no (each x,y coordinate provides its own sequence of numbers

pub fn float_range( &self, x: i32, y: i32, z: i32, n: i32, min: f32, max: f32 ) -> f32

Return a random floating point number in the range specified, for the given x,y coordinates and GeglRandom provided, if multiple different numbers are needed pass in incrementing n’s.

x

x coordinate

y

y coordinate

z

z coordinate (mipmap level)

n

number no (each x,y coordinate provides its own sequence of numbers

min

minimum value

max

maximum value

pub fn int(&self, x: i32, y: i32, z: i32, n: i32) -> u32

Return a random integer number in range 0 .. MAX_UINT

x

x coordinate

y

y coordinate

z

z coordinate (mipmap level)

n

number no (each x,y coordinate provides its own sequence of numbers

pub fn int_range( &self, x: i32, y: i32, z: i32, n: i32, min: i32, max: i32 ) -> i32

Return a random integer point number in the range specified, for the given x,y coordinates and GeglRandom provided, if multiple different numbers are needed pass in incrementing n’s.

x

x coordinate

y

y coordinate

z

z coordinate (mipmap level)

n

number no (each x,y coordinate provides its own sequence of numbers

min

minimum value

max

maximum value+1

pub fn set_seed(&mut self, seed: u32)

Change the seed of an existing GeglRandom.

seed

an integer seed, change for different permutation.

Trait Implementations

impl Clone for Random

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Random

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Random

fn default() -> Self

Returns the “default value” for a type.

impl From<Random> for Value

fn from(o: Random) -> Self

Converts to this type from the input type.

impl HasParamSpec for Random

type ParamSpec = ParamSpecBoxed

type SetValue = Random

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Random>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Random

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Random

fn cmp(&self, other: &Random) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Random> for Random

fn eq(&self, other: &Random) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Random> for Random

fn partial_cmp(&self, other: &Random) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Random

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Random

impl StructuralEq for Random

impl StructuralPartialEq for Random