DgsCreateMask - Revision history

Thisdp: /* Example */

2020-02-09T08:42:47Z

Example

← Older revision		Revision as of 08:42, 9 February 2020
Line 32:		Line 32:
	Returns a dgs-dxmask element (DGS Plugin Type)[ shader (Element Type) ] if succeed, ''false'' otherwise		Returns a dgs-dxmask element (DGS Plugin Type)[ shader (Element Type) ] if succeed, ''false'' otherwise

	==Example==		==Example 1==
			This example shows texture masked texture.
			<syntaxhighlight lang="lua">
			DGS = exports.dgs --get exported functions from dgs

			local sourceTex = dxCreateTexture("tex1.png") -- Your Texture
			local maskTex= dxCreateTexture("tex2.png") -- Your Mask ( You'd better use black&white texture )
			local mask = DGS:dgsCreateMask(sourceTex,maskTex)
			local image = DGS:dgsCreateImage(300,300,200,200,mask,false)
			</syntaxhighlight>

			==Example 2==
	This example shows a QRCode without background .		This example shows a QRCode without background .
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Thisdp at 08:40, 9 February 2020

2020-02-09T08:40:04Z

← Older revision		Revision as of 08:40, 9 February 2020
Line 9:		Line 9:
	</syntaxhighlight>		</syntaxhighlight>

	[[Image:DGS_Removed_BG_QRCode.png\|~~256px~~\|thumb\|Example QRCode with background color removed]]		[[Image:DGS_Removed_BG_QRCode.png\|128px\|thumb\|Example QRCode with background color removed]]
	===Required Arguments===		===Required Arguments===
	*'''sourceTexture: ''' A texture you want to be masked.		*'''sourceTexture: ''' A texture you want to be masked.

Thisdp: /* Required Arguments */

2020-02-09T08:39:46Z

Required Arguments

← Older revision		Revision as of 08:39, 9 February 2020
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''sourceTexture: ''' A texture you want to be masked.		*'''sourceTexture: ''' A texture you want to be masked.
	*'''mask: ''' A texture/shader/string(built-in mask) of the mask. Built in masks are as follows:		*'''mask: ''' A texture/shader/string(built-in mask) of the mask. '''Built-in masks''' are as follows:
	**'''circle:''' Make source texture a circle. Here is the settings:		**'''circle:''' Make source texture a circle. Here is the settings:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 24:		Line 24:
	filterRange = filterRange -- The color range		filterRange = filterRange -- The color range
	isPixelated = isPixelated -- whether the texture should be pixelated like MineCraft or smooth scaled.		isPixelated = isPixelated -- whether the texture should be pixelated like MineCraft or smooth scaled.
	</syntaxhighlight>		</syntaxhighlight>

	===Optional Arguments===		===Optional Arguments===

Thisdp: Created page with "NOTOC {{Client function}} This function creates a DGS mask. ==Syntax== element dgsCreateMask( texture sourceTexture, texture/shader/string..."

2020-02-09T08:37:57Z

Created page with "__NOTOC__ {{Client function}} This function creates a DGS mask. ==Syntax== <syntaxhighlight lang="lua"> element dgsCreateMask( texture sourceTexture, texture/shader/string..."

New page

__NOTOC__
{{Client function}}

This function creates a DGS mask.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateMask( texture sourceTexture, texture/shader/string mask [, table settings ] )
</syntaxhighlight>

[[Image:DGS_Removed_BG_QRCode.png|256px|thumb|Example QRCode with background color removed]]
===Required Arguments===
*'''sourceTexture: ''' A texture you want to be masked.
*'''mask: ''' A texture/shader/string(built-in mask) of the mask. Built in masks are as follows:
**'''circle:''' Make source texture a circle. Here is the settings:
<syntaxhighlight lang="lua">
offset = { offsetX, offsetY, relative } -- Offsets of the source texture
scale = { scaleX, scaleY, relative } -- Scale of the source texture
radius = radius -- The radius of the mask shader which ranges from 0 to 0.5 (recommended)
</syntaxhighlight>
**'''backgroundFilter:''' Remove specific color with specific range from the texture. Here is the settings:
<syntaxhighlight lang="lua">
filterRGB = {R,G,B} -- The color you want to remove.
filterRange = filterRange -- The color range
isPixelated = isPixelated -- whether the texture should be pixelated like MineCraft or smooth scaled.
</syntaxhighlight>

===Optional Arguments===
*'''settings: ''' A table of the settings of mask (specified by mask type).

===Returns===
Returns a dgs-dxmask element (DGS Plugin Type)[ shader (Element Type) ] if succeed, ''false'' otherwise

==Example==
This example shows a QRCode without background .
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local QRCode = DGS:dgsRequestQRCode("https://wiki.multitheftauto.com/wiki/Resource:Dgs")
local mask = DGS:dgsCreateMask(QRCode,"backgroundFilter",{
filterRGB={255,255,255},
filterRange=0.01,
isPixelated=true,
})
local image = DGS:dgsCreateImage(300,300,128,128,mask,false)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCreateMask - Revision history

Thisdp: /* Example */

Thisdp at 08:40, 9 February 2020

Thisdp: /* Required Arguments */

Thisdp: Created page with "__NOTOC__ {{Client function}} This function creates a DGS mask. ==Syntax== element dgsCreateMask( texture sourceTexture, texture/shader/string..."

Thisdp: Created page with "NOTOC {{Client function}} This function creates a DGS mask. ==Syntax== element dgsCreateMask( texture sourceTexture, texture/shader/string..."