Function __global->re_hue_image

Definitions

sources/themewizard.php

  • Generate a theme image by converting an existing one to a new colour scheme via re-hueing.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$path PATH No No required parameter N/A N/A The image path
$seed string No No required parameter N/A N/A The colour code of our hue
$source_theme ID_TEXT No No required parameter N/A N/A The theme this is being generated from
$also_s_and_v boolean No No False N/A N/A Whether to also adjust the S and V components
$invert boolean No No False N/A N/A Whether to invert the colours

Returns

  • The image (resource of text)
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate a theme image by converting an existing one to a new colour scheme via re-hueing.
 *
 * @param  PATH $path The image path
 * @param  string $seed The colour code of our hue
 * @param  ID_TEXT $source_theme The theme this is being generated from
 * @param  boolean $also_s_and_v Whether to also adjust the S and V components
 * @param  boolean $invert Whether to invert the colours
 * @return mixed The image (resource of text)
 */
function re_hue_image(string $path, string $seed, string $source_theme, bool $also_s_and_v = false, bool $invert = false)