DgsCreateCustomRenderer - Revision history

Thisdp: /* Optional Arguments */

2022-03-25T16:20:39Z

Optional Arguments

← Older revision		Revision as of 16:20, 25 March 2022
Line 11:		Line 11:

	===Optional Arguments===		===Optional Arguments===
	*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.		*'''renderFunction''': A string of lua code which will be the new renderer function of the custom renderer.
	**''Predefined Variable of renderFunction'': Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]		**''Predefined Variable of renderFunction'': Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]
	**Global:		**Global:

Thisdp at 16:20, 25 March 2022

2022-03-25T16:20:06Z

← Older revision		Revision as of 16:20, 25 March 2022
Line 3:		Line 3:
	This function creates a custom renderer that can be used in any texture required property of dgs elements, which is useful for creating custom DGS plugins.		This function creates a custom renderer that can be used in any texture required property of dgs elements, which is useful for creating custom DGS plugins.

	'''Notice:''' The environment of '''renderFunction''' is inside DGS. You have to use [[dgsSetProperty]] if you want to pass something into the '''renderFunction'''		'''Notice:''' The environment of '''renderFunction''' is inside DGS. You have to use [[dgsSetProperty]] if you want to pass something into the '''renderFunction'''.

	==Syntax==		==Syntax==

Thisdp at 16:19, 25 March 2022

2022-03-25T16:19:57Z

← Older revision		Revision as of 16:19, 25 March 2022
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function creates a custom renderer that can be used in any texture required property of dgs elements, which is useful for creating custom DGS plugins.		This function creates a custom renderer that can be used in any texture required property of dgs elements, which is useful for creating custom DGS plugins.

			'''Notice:''' The environment of '''renderFunction''' is inside DGS. You have to use [[dgsSetProperty]] if you want to pass something into the '''renderFunction'''

	==Syntax==		==Syntax==

Thisdp: /* Optional Arguments */

2022-02-01T07:19:26Z

Optional Arguments

@@ Line 25: / Line 25: @@
 ***'''color''': The color to be applied.
 ***'''postGUI''': Whether the dx draw is require postGUI
 **''When dxDrawType is "text"'':
 ===Returns===

Thisdp: /* Optional Arguments */

2022-02-01T07:16:55Z

Optional Arguments

← Older revision		Revision as of 07:16, 1 February 2022
Line 10:		Line 10:
	===Optional Arguments===		===Optional Arguments===
	*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.		*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.
	**Predefined Variable of renderFunction: Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]		**''Predefined Variable of renderFunction'': Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]
	**Global:		**Global:
	**'''dxDrawType''': A string indicates what kind of drawing, can be "'''image'''" or "'''text'''".		***'''dxDrawType''': A string indicates what kind of drawing, can be "'''image'''" or "'''text'''".
	**Passed By Function:		**Passed By Function:
	**''dxDrawType = "image"'':		**''When dxDrawType is "image"'':
	***'''posX''': Absolute X position of the renderer's bounding box.		***'''posX''': Absolute X position of the renderer's bounding box.
	***'''posY''': Absolute Y position of the renderer's bounding box.		***'''posY''': Absolute Y position of the renderer's bounding box.
Line 25:		Line 25:
	***'''color''': The color to be applied.		***'''color''': The color to be applied.
	***'''postGUI''': Whether the dx draw is require postGUI		***'''postGUI''': Whether the dx draw is require postGUI
	**''dxDrawType = "text"'':
			**''When dxDrawType is "text"'':

	===Returns===		===Returns===

Thisdp: /* Optional Arguments */

2022-02-01T07:16:01Z

Optional Arguments

← Older revision		Revision as of 07:16, 1 February 2022
Line 10:		Line 10:
	===Optional Arguments===		===Optional Arguments===
	*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.		*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.
	**~~'''~~Predefined Variable of renderFunction~~'''~~: Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]		**Predefined Variable of renderFunction: Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]
	**Global:		**Global:
	**'''dxDrawType''': A string indicates what kind of drawing, can be "'''image'''" or "'''text'''".		**'''dxDrawType''': A string indicates what kind of drawing, can be "'''image'''" or "'''text'''".

Thisdp: /* Optional Arguments */

2022-02-01T07:15:44Z

Optional Arguments

← Older revision		Revision as of 07:15, 1 February 2022
Line 9:		Line 9:

	===Optional Arguments===		===Optional Arguments===
	*'''renderFunction:''' A string of lua code which will be the new renderer of the custom renderer.		*'''renderFunction''': A string of lua code which will be the new renderer of the custom renderer.
	**'''Predefined Variable of renderFunction:''' For detail, see [[dxDrawImage]]		**'''Predefined Variable of renderFunction''': Determined by '''dxDrawType'''. For detail, see [[dxDrawImage]] or [[dxDrawText]]
	***'''posX:''' Absolute X position of the renderer's bounding box.		**Global:
	***'''posY:''' Absolute Y position of the renderer's bounding box.		**'''dxDrawType''': A string indicates what kind of drawing, can be "'''image'''" or "'''text'''".
	***'''width:''' Absolute width of the renderer's bounding box.		**Passed By Function:
	***'''height:''' Absolute height of the renderer's bounding box.		**''dxDrawType = "image"'':
	***'''self:''' The custom renderer itself.		***'''posX''': Absolute X position of the renderer's bounding box.
	***'''rotation:''' The rotation of renderer's bounding box.		***'''posY''': Absolute Y position of the renderer's bounding box.
	***'''rotationCenterOffsetX:''' The rotation center offset x of renderer's bounding box.		***'''width''': Absolute width of the renderer's bounding box.
	***'''rotationCenterOffsetY:''' The rotation center offset x of renderer's bounding box.		***'''height''': Absolute height of the renderer's bounding box.
	***'''color:''' The color to be applied.		***'''self''': The custom renderer itself.
	***'''postGUI:''' Whether the dx draw is require postGUI		***'''rotation''': The rotation of renderer's bounding box.
			***'''rotationCenterOffsetX''': The rotation center offset x of renderer's bounding box.
			***'''rotationCenterOffsetY''': The rotation center offset x of renderer's bounding box.
			***'''color''': The color to be applied.
			***'''postGUI''': Whether the dx draw is require postGUI
			**''dxDrawType = "text"'':

	===Returns===		===Returns===

Thisdp: /* Example */

2020-04-28T15:54:26Z

Example

← Older revision		Revision as of 15:54, 28 April 2020
Line 35:		Line 35:
	local tex = dxCreateTexture("exampleTexture.png") --Create a texture		local tex = dxCreateTexture("exampleTexture.png") --Create a texture
	local image = DGS:dgsCreateImage(300,300,200,200,customRenderer,false) --Apply the custom renderer		local image = DGS:dgsCreateImage(300,300,200,200,customRenderer,false) --Apply the custom renderer
			DGS:dgsSetProperty(customRenderer,"customTexture",tex) --Make a reference for the texture that can be used in the render function.
	DGS:dgsAttachToAutoDestroy(tex,image) --The texture will be destroyed when the image destroys		DGS:dgsAttachToAutoDestroy(tex,image) --The texture will be destroyed when the image destroys
	DGS:dgsAttachToAutoDestroy(customRenderer,image) --The custom renderer will be destroyed when the image destroys		DGS:dgsAttachToAutoDestroy(customRenderer,image) --The custom renderer will be destroyed when the image destroys

Thisdp at 15:39, 28 April 2020

2020-04-28T15:39:15Z

← Older revision		Revision as of 15:39, 28 April 2020
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateCustomRenderer( string renderFunction )		element dgsCreateCustomRenderer( [ string renderFunction ] )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Required~~ Arguments===		===Optional Arguments===
	*'''renderFunction:''' A string of lua code which will be the new renderer of the custom renderer.		*'''renderFunction:''' A string of lua code which will be the new renderer of the custom renderer.
	**'''Predefined Variable of renderFunction:''' For detail, see [[dxDrawImage]]		**'''Predefined Variable of renderFunction:''' For detail, see [[dxDrawImage]]

Thisdp: /* Example */

2020-04-28T15:37:06Z

Example

← Older revision		Revision as of 15:37, 28 April 2020
Line 36:		Line 36:
	local image = DGS:dgsCreateImage(300,300,200,200,customRenderer,false) --Apply the custom renderer		local image = DGS:dgsCreateImage(300,300,200,200,customRenderer,false) --Apply the custom renderer
	DGS:dgsAttachToAutoDestroy(tex,image) --The texture will be destroyed when the image destroys		DGS:dgsAttachToAutoDestroy(tex,image) --The texture will be destroyed when the image destroys
			DGS:dgsAttachToAutoDestroy(customRenderer,image) --The custom renderer will be destroyed when the image destroys

	setTimer(function()		setTimer(function()