ImagePathFunctions - Revision history

Celtic Minstrel: /* PAD: Pad function */ That fake offset thing does not work on all images, so make that clear.

2025-10-05T19:06:27Z

PAD: Pad function: That fake offset thing does not work on all images, so make that clear.

← Older revision		Revision as of 19:06, 5 October 2025
Line 216:		Line 216:
	*called with a single number like ''~PAD(10)'' and it will add a 10 pixel padding to every side.		*called with a single number like ''~PAD(10)'' and it will add a 10 pixel padding to every side.
	*called with keys (top, t, right, r, bottom, b, left, l) like ''~PAD(bottom=10, t=5)'' and it will pad those sides by that much.		*called with keys (top, t, right, r, bottom, b, left, l) like ''~PAD(bottom=10, t=5)'' and it will pad those sides by that much.
	Can be used to create a fake offset by padding one side of an image in order to push it in the opposite direction.		Can be used to create a fake offset on centered images by padding one side of an image in order to push it in the opposite direction.

	=== MASK: Mask function ===		=== MASK: Mask function ===

2025-09-29T17:24:07Z

PAD: Pad function

← Older revision		Revision as of 17:24, 29 September 2025
Line 210:		Line 210:

	=== PAD: Pad function===		=== PAD: Pad function===
	{{devfeature1.19\|16}}		{{devfeature1.19\|17}}
	Extends side(s) of an image with transparent pixels.		Extends side(s) of an image with transparent pixels.

2025-09-29T17:14:05Z

PAD: Pad function

← Older revision		Revision as of 17:14, 29 September 2025
Line 214:		Line 214:

	'''~PAD(..)'''		'''~PAD(..)'''
	*called with a single number like ~PAD(10) and it will add a 10 pixel padding to every side.		*called with a single number like ''~PAD(10)'' and it will add a 10 pixel padding to every side.
	*called with keys (top, t, right, r, bottom, b, left, l) like ~PAD(bottom=10, t=5) and it will pad those sides by that much.		*called with keys (top, t, right, r, bottom, b, left, l) like ''~PAD(bottom=10, t=5)'' and it will pad those sides by that much.
	*can be used to create a fake offset by padding one side of an image in order to push it in the opposite direction.		Can be used to create a fake offset by padding one side of an image in order to push it in the opposite direction.

	=== MASK: Mask function ===		=== MASK: Mask function ===

2025-09-29T17:10:04Z

Cut-and-paste

← Older revision		Revision as of 17:10, 29 September 2025
Line 186:		Line 186:
	'''~XBRZ(n)'''		'''~XBRZ(n)'''

	== Cut-~~and~~-~~paste~~ ==		== Cut-paste-extend ==

	=== BLIT: Blit function ===		=== BLIT: Blit function ===
Line 208:		Line 208:

	'''~CROP_TRANSPARENCY()'''		'''~CROP_TRANSPARENCY()'''

			=== PAD: Pad function===
			{{devfeature1.19\|16}}
			Extends side(s) of an image with transparent pixels.

			'''~PAD(..)'''
			*called with a single number like ~PAD(10) and it will add a 10 pixel padding to every side.
			*called with keys (top, t, right, r, bottom, b, left, l) like ~PAD(bottom=10, t=5) and it will pad those sides by that much.
			*can be used to create a fake offset by padding one side of an image in order to push it in the opposite direction.

	=== MASK: Mask function ===		=== MASK: Mask function ===

2024-12-29T22:35:09Z

BLIT: Blit function: translating blit to english ; )

← Older revision		Revision as of 22:35, 29 December 2024
Line 189:		Line 189:

	=== BLIT: Blit function ===		=== BLIT: Blit function ===
	Blit the parameter image on the main image. Example: peasant.png~BLIT(hat.png,30,10)		Blit (superimpose) the parameter image on the main image. Example: peasant.png~BLIT(hat.png,30,10)

	'''~BLIT(src,x,y)'''		'''~BLIT(src,x,y)'''

2024-10-29T09:01:13Z

CROP_TRANSPARENCY: Fix IPF name typo. The game code says CROP_TRANSPARENCY()

← Older revision		Revision as of 09:01, 29 October 2024
Line 203:		Line 203:
	* ''height'': height of the selected region. Must be less than or equal to the original image's height, and must not be negative.		* ''height'': height of the selected region. Must be less than or equal to the original image's height, and must not be negative.

	=== ~~CROP_TRANSPARENT~~ ===		=== CROP_TRANSPARENCY ===
	{{devfeature1.17\|26}}		{{devfeature1.17\|26}}
	Removes any transparent padding from around an image.		Removes any transparent padding from around an image.

	'''~~~CROP_TRANSPARENT~~()'''		'''~CROP_TRANSPARENCY()'''

	=== MASK: Mask function ===		=== MASK: Mask function ===

2024-06-25T12:45:23Z

PAL: Palette-switch function

← Older revision		Revision as of 12:45, 25 June 2024
Line 75:		Line 75:
	*''target color palette'' - the new palette to take the place of the source colors in the image.		*''target color palette'' - the new palette to take the place of the source colors in the image.

	A color palette can be either the attribute name from '''[color_palette]''' (like magenta) or a comma separated list of hex color values.		A color palette can be either the attribute name from '''[[GameConfigWML#Color_Palettes\|[color_palette]]]''' (like magenta) or a comma separated list of hex color values.

	=== RC: Re-Color function ===		=== RC: Re-Color function ===

2024-06-25T12:39:40Z

PAL: Palette-switch function

← Older revision		Revision as of 12:39, 25 June 2024
Line 74:		Line 74:
	*''source color palette'' - the first parameter is a source color palette, such as magenta. Do not surround this parameter with quotes.		*''source color palette'' - the first parameter is a source color palette, such as magenta. Do not surround this parameter with quotes.
	*''target color palette'' - the new palette to take the place of the source colors in the image.		*''target color palette'' - the new palette to take the place of the source colors in the image.

			A color palette can be either the attribute name from '''[color_palette]''' (like magenta) or a comma separated list of hex color values.

	=== RC: Re-Color function ===		=== RC: Re-Color function ===

2024-04-19T08:06:13Z

2024-02-01T20:47:53Z

CROP_TRANSPARENT

← Older revision		Revision as of 20:47, 1 February 2024
Line 202:		Line 202:

	=== CROP_TRANSPARENT ===		=== CROP_TRANSPARENT ===
			{{devfeature1.17\|26}}
	Removes any transparent padding from around an image.		Removes any transparent padding from around an image.

← Older revision		Revision as of 08:06, 19 April 2024
Line 341:		Line 341:
	* [[FancyAddonIcons]] - Tips and tricks for advanced Image Path Function manipulation		* [[FancyAddonIcons]] - Tips and tricks for advanced Image Path Function manipulation
	* [[DataURI]] - An image path may also contain the image directly, as a Base64 encoded string		* [[DataURI]] - An image path may also contain the image directly, as a Base64 encoded string
	* [https://irydacea.me/projects/~~wesnoth-rcx Wesnoth RCX~~] - Tool to preview unit recoloring. Covers the effects of the [[#RC:_Re-Color_Function\|RC]], [[#TC: Team-Color Function\|TC]] and [[#PAL:_Palette-switch_Function\|PAL]] functions.		* [https://irydacea.me/projects/wespal Wespal] - Tool to preview unit recoloring. Covers the effects of the [[#RC:_Re-Color_Function\|RC]], [[#TC: Team-Color Function\|TC]] and [[#PAL:_Palette-switch_Function\|PAL]] functions.
	* [https://github.com/wesnoth/wesnoth/blob/master/src/image_modifications.cpp src/image_modifications.cpp] - file where IPFs are implemented		* [https://github.com/wesnoth/wesnoth/blob/master/src/image_modifications.cpp src/image_modifications.cpp] - file where IPFs are implemented
	[[Category:WML Reference]]		[[Category:WML Reference]]