DxSetBlendMode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dxSetBlendMode( string blendMode )
bool dxSetBlendMode ( string blendMode )
</syntaxhighlight>  
</syntaxhighlight>  



Revision as of 19:23, 20 September 2012

This function sets the current blend mode for the dxDraw functions. Changing the blend mode can increase the quality when drawing text or certain other images to a render target. As a general guide use modulate_add when drawing text to a render target, and add when drawing the render target to the screen. Don't forget to restore the default blend at the end.

Syntax

bool dxSetBlendMode ( string blendMode )

Required Arguments

  • blendMode : The blend mode to use which can be one of:
    • blend: The source textures are alpha blended to the screen/render target. The is the default mode for drawing and gives the results we all know and love.
    • add: The source textures are added to the screen/render target.
    • modulate_add: The source textures are multiplied by the alpha and then added to the screen/render target.
ADDED/UPDATED IN VERSION 1.3.0 r4425:
    • overwrite : The source textures are overwritten. This can be useful for clearing render targets.

Returns

Returns true if successful, or false if invalid arguments were passed to the function.

Example

--TODO

Requirements

Minimum server version n/a
Minimum client version 1.3.0-9.03782

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.03782" />

Changelog

Version Description
1.3.0-9.04425 Added overwrite

See Also