raylib::builder::RlImageBuilder Class Reference

Builder to create a RlImage easily. More...

#include <RlImageBuilder.hpp>

Inheritance diagram for raylib::builder::RlImageBuilder:

Collaboration diagram for raylib::builder::RlImageBuilder:

Public Types
enum	ImageType {   ImageColor = Width | Height | Color, ImageGradientV = Width | Height | Top | Bottom, ImageGradientH = Width | Height | Left | Right, ImageGradientRadial = Width | Height | Density | Inner | Outer,   ImageChecked = Width | Height | ChecksX | ChecksY | Col1 | Col2, ImageWhiteNoise = Width | Height | Factor, ImageCellular = Width | Height | TitleSize }
	Type of image. More...

Public Member Functions
	RlImageBuilder ()
	Construct a new RlImageBuilder object. More...
RlImageBuilder &	setType (const ImageType &type)
	Set the type of image. More...
RlImageBuilder &	setWidth (const int &width)
	Set the width of image. More...
RlImageBuilder &	setHeight (const int &height)
	Set the height of image. More...
RlImageBuilder &	setColor (const RlColor &color)
	Set the color of image. More...
RlImageBuilder &	setTop (const RlColor &top)
	Set the Top color of image. More...
RlImageBuilder &	setBottom (const RlColor &bottom)
	Set the Bottom color of image. More...
RlImageBuilder &	setLeft (const RlColor &left)
	Set the Left color of image. More...
RlImageBuilder &	setRight (const RlColor &right)
	Set the Right color of image. More...
RlImageBuilder &	setInner (const RlColor &inner)
	Set the Inner color of image. More...
RlImageBuilder &	setOuter (const RlColor &outer)
	Set the Outer color of image. More...
RlImageBuilder &	setCol1 (const RlColor &col1)
	Set the first color. More...
RlImageBuilder &	setCol2 (const RlColor &col2)
	Set the second color. More...
RlImageBuilder &	setFactor (const float &factor)
	The factor of the white noise image. More...
RlImageBuilder &	setDensity (const float &density)
	The density of the radial gradient image. More...
RlImageBuilder &	setTitleSize (const int &titleSize)
	The title size of the cellular image. More...
RlImageBuilder &	setChecksX (const int &checksX)
	The number of checks X of the checked image. More...
RlImageBuilder &	setChecksY (const int &checksY)
	The number of checks Y of the checked image. More...
raylib::image::RlImage	build () override
	Build the RlImage object. More...

Detailed Description

Builder to create a RlImage easily.

Member Enumeration Documentation

ImageType

enum raylib::builder::RlImageBuilder::ImageType

Type of image.

Enumerator
ImageColor	Create an image with a color
ImageGradientV	Create an image with a gradient vertical
ImageGradientH	Create an image with a gradient horizontal
ImageGradientRadial	Create an image with a gradient radial
ImageChecked	Create an image checked
ImageWhiteNoise	Create an image with a white noise
ImageCellular	Create an image with a cellular automaton

Constructor & Destructor Documentation

RlImageBuilder()

raylib::builder::RlImageBuilder::RlImageBuilder

(

)

Construct a new RlImageBuilder object.

Member Function Documentation

build()

raylib::image::RlImage raylib::builder::RlImageBuilder::build ( )

overridevirtual

Build the RlImage object.

Exceptions

BuilderException

Returns

the RlImage object

Implements raylib::builder::IBuilder< raylib::image::RlImage >.

Here is the call graph for this function:

setBottom()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setBottom

(

const RlColor &

bottom

)

Set the Bottom color of image.

Parameters

bottom

the Bottom color of image

Returns

the RlImageBuilder object

setChecksX()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setChecksX

(

const int &

checksX

)

The number of checks X of the checked image.

Parameters

checksX

the number of checks X of the checked image

Returns

the RlImageBuilder object

setChecksY()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setChecksY

(

const int &

checksY

)

The number of checks Y of the checked image.

Parameters

checksY

the number of checks Y of the checked image

Returns

the RlImageBuilder object

setCol1()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setCol1

(

const RlColor &

col1

)

Set the first color.

Parameters

col1	the first color

Returns

the RlImageBuilder object

setCol2()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setCol2

(

const RlColor &

col2

)

Set the second color.

Parameters

col2	the second color

Returns

the RlImageBuilder object

setColor()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setColor

(

const RlColor &

color

)

Set the color of image.

Parameters

color

the color of image

Returns

the RlImageBuilder object

setDensity()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setDensity

(

const float &

density

)

The density of the radial gradient image.

Parameters

density

the density of the radial gradient image

Returns

the RlImageBuilder object

setFactor()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setFactor

(

const float &

factor

)

The factor of the white noise image.

Parameters

factor

the factor of image

Returns

the RlImageBuilder object

setHeight()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setHeight

(

const int &

height

)

Set the height of image.

Parameters

height

the height of image

Returns

the RlImageBuilder object

setInner()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setInner

(

const RlColor &

inner

)

Set the Inner color of image.

Parameters

inner

the Inner color of image

Returns

the RlImageBuilder object

setLeft()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setLeft

(

const RlColor &

left

)

Set the Left color of image.

Parameters

left	the Left color of image

Returns

the RlImageBuilder object

setOuter()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setOuter

(

const RlColor &

outer

)

Set the Outer color of image.

Parameters

outer

the Outer color of image

Returns

the RlImageBuilder object

setRight()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setRight

(

const RlColor &

right

)

Set the Right color of image.

Parameters

right

the Right color of image

Returns

the RlImageBuilder object

setTitleSize()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setTitleSize

(

const int &

titleSize

)

The title size of the cellular image.

Parameters

titleSize

the title size of the cellular image

Returns

the RlImageBuilder object

setTop()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setTop

(

const RlColor &

top

)

Set the Top color of image.

Parameters

top	the Top color of image

Returns

the RlImageBuilder object

setType()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setType

(

const ImageType &

type

)

Set the type of image.

Parameters

type	type of image

Returns

the RlImageBuilder object

setWidth()

raylib::builder::RlImageBuilder & raylib::builder::RlImageBuilder::setWidth

(

const int &

width

)

Set the width of image.

Parameters

width

the width of image

Returns

the RlImageBuilder object

---

The documentation for this class was generated from the following files:

• raylib-cpp/include/raylib/Image/RlImageBuilder.hpp
• raylib-cpp/src/raylib/Image/RlImageBuilder.cpp