Badge Display Code Documentation - Revision history

Aloha at 01:12, 25 March 2025

2025-03-25T01:12:41Z

← Older revision		Revision as of 20:12, 24 March 2025
Line 9:		Line 9:
	For example where you place invert_image(); will effect the way it works, you can make it only effect part of the badge, you can even use multiple invert_image();'s in series to invert part of the badge conditionally based on state (underage, UDF, product purchased, membership, what have you).		For example where you place invert_image(); will effect the way it works, you can make it only effect part of the badge, you can even use multiple invert_image();'s in series to invert part of the badge conditionally based on state (underage, UDF, product purchased, membership, what have you).

	=== Badgecode ~~Co-ordinate~~ system. ===		=== Badgecode Coordinate system. ===

	The system requires ~~co-ordinates~~, and these co-ordinates can be passed in many ways, the most common way will be to pass the just numbers, and numbers will represent pixels in the image your attempting to draw. However, several other methods are possible, including percentages, inches, cm, mm, points, and pixels. In addition the numbers used can be negative which will make them count from the opposite direction.		The system requires coordinates, and these co-ordinates can be passed in many ways, the most common way will be to pass the just numbers, and numbers will represent pixels in the image your attempting to draw. However, several other methods are possible, including percentages, inches, cm, mm, points, and pixels. In addition the numbers used can be negative which will make them count from the opposite direction.

	=== Variables ===		=== Variables ===

Trapa: Fixed typoe codebar to correct codabar

2022-10-31T00:50:25Z

Fixed typoe codebar to correct codabar

← Older revision		Revision as of 19:50, 30 October 2022
Line 118:		Line 118:

	* '''draw_barcode("string",[x,y],Optional Arguments here)''' - Draws a barcode at the x,y co-ordinates with the following optional arguments which can be passed in any order and must be seperated by a comma,		* '''draw_barcode("string",[x,y],Optional Arguments here)''' - Draws a barcode at the x,y co-ordinates with the following optional arguments which can be passed in any order and must be seperated by a comma,
	** <nowiki>format=<code128\|code39\|~~codebar~~> - Defaults to code39</nowiki>		** <nowiki>format=<code128\|code39\|codabar> - Defaults to code39</nowiki>
	** <nowiki>align=<left\|center\|right> - Defaults to Left</nowiki>		** <nowiki>align=<left\|center\|right> - Defaults to Left</nowiki>
	** <nowiki>orientation=<horizontal\|vertical> - Defaults to Horizontal</nowiki>		** <nowiki>orientation=<horizontal\|vertical> - Defaults to Horizontal</nowiki>

Aloha: /* Image Functions */

2022-01-12T20:52:10Z

Image Functions

← Older revision		Revision as of 15:52, 12 January 2022
Line 93:		Line 93:
	*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''image_contrast(n);''' - Adjust image contrast - Valid range is -100 to 100, note, negative numbers are more contrast, positive numbers are less.		* '''image_contrast(n);''' - Adjust image contrast - Valid range is -100 to 100, note, negative numbers are more contrast, positive numbers are less (this is the way the underlying library works, no sane person would design it this way).
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0), this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0), this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

Aloha: /* Image Functions */

2022-01-12T20:51:18Z

Image Functions

← Older revision		Revision as of 15:51, 12 January 2022
Line 92:		Line 92:
	*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	* '''~~image_contrast~~(n);''' - Adjust image ~~contrast~~ - ~~note~~, ~~negative numbers are more contrast~~, ~~positive numbers are less~~.		* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''~~image_brightness~~(n);''' - Adjust image ~~brightness~~ - Valid range is -~~255~~ to ~~255~~, ~~255 is most brightness~~, ~~-255 is least~~.		* '''image_contrast(n);''' - Adjust image contrast - Valid range is -100 to 100, note, negative numbers are more contrast, positive numbers are less.
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0), this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0), this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

Aloha: /* Image Functions */

2022-01-12T20:50:23Z

Image Functions

← Older revision		Revision as of 15:50, 12 January 2022
Line 95:		Line 95:
	* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) ~~by the parse_color function~~, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0), this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

	===== Layout Assistance Function =====		===== Layout Assistance Function =====

Aloha: /* Image Functions */

2022-01-12T20:48:23Z

Image Functions

← Older revision		Revision as of 15:48, 12 January 2022
Line 92:		Line 92:
	*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.		* '''image_contrast(n);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.
	* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness(n);''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

Aloha: /* Image Functions */

2022-01-12T20:44:59Z

Image Functions

← Older revision		Revision as of 15:44, 12 January 2022
Line 95:		Line 95:
	* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.
	Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

	===== Layout Assistance Function =====		===== Layout Assistance Function =====

Aloha: /* Image Functions */

2022-01-12T20:44:24Z

Image Functions

← Older revision		Revision as of 15:44, 12 January 2022
Line 92:		Line 92:
	*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.
	* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.		* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.
	* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
	* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.		* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.
			* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use.
			Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.

	===== Layout Assistance Function =====		===== Layout Assistance Function =====

Aloha: /* Image Functions */

2022-01-12T20:43:47Z

Image Functions

← Older revision		Revision as of 15:43, 12 January 2022
Line 92:		Line 92:
	*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.		*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
	* '''tint_image(r,g,b,''a'') - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.		* '''tint_image(r,g,b,''a'')''' - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.
	* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.		* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.
	* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.		* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.

Aloha at 20:43, 12 January 2022

2022-01-12T20:43:20Z

← Older revision		Revision as of 15:43, 12 January 2022
Line 90:		Line 90:
	* '''draw_image("filename",[p1x,p1y],[p2x,p2y])''' - Draw the specified image with the top left of the image at point 1, and the lower right of the image at point 2. If IMAGE_UID### is specified instead of a filename the image will be pulled from the badge_images table and used instead. There is no space between IMAGE_UID and the Number of the badge_image.		* '''draw_image("filename",[p1x,p1y],[p2x,p2y])''' - Draw the specified image with the top left of the image at point 1, and the lower right of the image at point 2. If IMAGE_UID### is specified instead of a filename the image will be pulled from the badge_images table and used instead. There is no space between IMAGE_UID and the Number of the badge_image.
	* '''flood_fill(r,g,b)''' - will perform a flood fill on the image at 2,2		* '''flood_fill(r,g,b)''' - will perform a flood fill on the image at 2,2
			*'''invert_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
			*'''grayscale_image();''' - this function will invert the colors or intensity of all functions which appear after this function.
			* '''tint_image(r,g,b,''a'') - will colorize the entire image based on the RGB values specified. By default if you do not pass an alpha value in badgecode, one is inserted (0) by the parse_color function, this is fully opaque, you can adjust the intensity of the tinting effect by adjusting the transparency level. This is somewhat non-intuitive to use. Valid Alpha ranges are between 0 and 127, Valid Color Ranges are between 0 and 255.
			* '''image_contrast(0);''' - Adjust image contrast - note, negative numbers are more contrast, positive numbers are less.
			* '''image_brightness();''' - Adjust image brightness - Valid range is -255 to 255, 255 is most brightness, -255 is least.
			* '''emboss_image();''' - Adds an Artistic Embossed Look to an image.

	===== Layout Assistance Function =====		===== Layout Assistance Function =====
Line 123:		Line 129:

	==== Miscellaneous Functions ====		==== Miscellaneous Functions ====
			* '''label_convert''' - This is a special function to improve the quality of thermal prints when used with the cups print method, it gives a rough approximation of the work the legacy EPL print method does when doing its image conversion. However, as its direct CUPS, there is a performance improvement.
	* '''// comment''' - Using // will add comments to your draw code that won't render.		* '''// comment''' - Using // will add comments to your draw code that won't render.