faker::image Namespace Reference

Enumerations
enum class	ImageCategory {   Animals , Business , Cats , City ,   Food , Nightlife , Fashion , People ,   Nature , Sports , Technics , Transport }

Functions
FAKER_CXX_EXPORT std::string	imageUrl (unsigned width=640, unsigned height=480)
	Generates a random image url with `https://loremflickr.com/` or "https://picsum.photos".
FAKER_CXX_EXPORT std::string	urlLoremFlickr (unsigned width=640, unsigned height=480, std::optional< ImageCategory > category=std::nullopt)
	Generates a real image url with `https://loremflickr.com/`.
FAKER_CXX_EXPORT std::string	urlPicsumPhotos (unsigned width=640, unsigned height=480, std::optional< bool > greyscale=std::nullopt, std::optional< int > blur=std::nullopt)
	Generates a real image url with "https://picsum.photos" .
FAKER_CXX_EXPORT std::string	githubAvatarUrl ()
	Generates a random avatar from GitHub.
FAKER_CXX_EXPORT std::string	dimensions ()
	Generates a random image dimensions.
FAKER_CXX_EXPORT std::string_view	type ()
	Generates a random type of image.
FAKER_CXX_EXPORT std::string	dataUri (unsigned width=200, unsigned height=200, const std::string &color="000000", const std::string &type="svg-uri")
	Generates a random data uri containing an URL-encoded SVG image or a Base64-encoded SVG image.

Enumeration Type Documentation

ImageCategory

enum class faker::image::ImageCategory

strong

Enumerator
Animals
Business
Cats
City
Food
Nightlife
Fashion
People
Nature
Sports
Technics
Transport

Function Documentation

dataUri()

FAKER_CXX_EXPORT std::string faker::image::dataUri	(	unsigned	width = 200,
		unsigned	height = 200,
		const std::string &	color = "000000",
		const std::string &	type = "svg-uri" )

Generates a random data uri containing an URL-encoded SVG image or a Base64-encoded SVG image.

Parameters

width	The width of the image. Defaults to a random number between 1 and 3999.
height	The height of the image. Defaults to a random number between 1 and 3999.
color	The color of the image. Must be a color supported by svg.
type	The type of the image to return. Consisting of the file extension and the used encoding.

Returns

A string containing the data uri.

faker::image::dataUri() // 'data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%22http...'
faker::image::dataUri(200, 200, "000000", "svg-base64") // 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...'

dimensions()

FAKER_CXX_EXPORT std::string faker::image::dimensions

(

)

Generates a random image dimensions.

Returns

Random image dimensions.

faker::image::dimensions() // "1920x1080"

githubAvatarUrl()

FAKER_CXX_EXPORT std::string faker::image::githubAvatarUrl

(

)

Generates a random avatar from GitHub.

Returns

Url to github avatar.

faker::image::githubAvatarUrl() // "https://avatars.githubusercontent.com/u/9716558"

imageUrl()

FAKER_CXX_EXPORT std::string faker::image::imageUrl	(	unsigned	width = 640,
		unsigned	height = 480 )

Generates a random image url with `https://loremflickr.com/` or "https://picsum.photos".

Parameters

width	The width of the image. Defaults to `640`.
height	The height of the image. Defaults to `480`.

Returns

Random real image url from external service.

faker::image::imageUrl() // "https://loremflickr.com/640/480" or "https://picsum.photos/640/480"

type()

FAKER_CXX_EXPORT std::string_view faker::image::type

(

)

Generates a random type of image.

Returns

Type of image.

faker::image::type() // "png"

urlLoremFlickr()

FAKER_CXX_EXPORT std::string faker::image::urlLoremFlickr	(	unsigned	width = 640,
		unsigned	height = 480,
		std::optional< ImageCategory >	category = std::nullopt )

Generates a real image url with `https://loremflickr.com/`.

Parameters

width	The width of the image. Defaults to `640`.
height	The height of the image. Defaults to `480`.
category	The optional category of generated real image.

Returns

Random real image url from external service.

faker::image::urlLoremFlickr() // "https://loremflickr.com/640/480"
faker::image::urlLoremFlickr(800, 600) // "https://loremflickr.com/800/600"
faker::image::urlLoremFlickr(800, 600, ImageCategory::Animals) // "https://loremflickr.com/800/600/animals"

urlPicsumPhotos()

FAKER_CXX_EXPORT std::string faker::image::urlPicsumPhotos	(	unsigned	width = 640,
		unsigned	height = 480,
		std::optional< bool >	greyscale = std::nullopt,
		std::optional< int >	blur = std::nullopt )

Generates a real image url with "https://picsum.photos" .

Parameters

width	The width of the image. Defaults to `640`.
height	The height of the image. Defaults to `480`.
greyscale	The optional greyscale filter. True for apply or false for disabled
blur	The optional blur effect between 1 and 10

Returns

Random real image url from external service

faker::image::urlPicsPhotos() // "https://picsum.photos/640/480"
faker::image::urlPicsPhotos(800,600,true) // "https://picsum.photos/800/600?grayscale
faker::image::urlPicsPhotos(800,600,false,5) // "https://picsum.photos/800/600?blur=5
faker::image::urlPicsPhotos(800,600,true,1) // "https://picsum.photos/800/600?grayscale&blur=1