DxSetAspectRatioAdjustmentEnabled: Difference between revisions

Revision as of 19:55, 26 June 2013

	Script Example Missing Function DxSetAspectRatioAdjustmentEnabled needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

This function should be used when aligning the output of dxDraw calls with GTA HUD components. It can only be called during these events: onClientRender, onClientPreRender and onClientHUDRender, and is automatically disabled when these events return. So the function has to be called every frame, just like dxDraws.

Syntax

bool dxSetAspectRatioAdjustmentEnabled ( bool bEnabled [, float fSourceRatio = 4/3 ] )

Required Arguments

bEnabled: Should the adjustment be enabled or disabled.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

fSourceRatio : This should be set to the aspect ratio the dxDraw were originally designed with.

Returns

Returns true when it was changed successfully, or false otherwise.

Requirements

This template will be deleted.

Example

addEventHandler("onClientRender",root,
    function()
        dxDrawText("Hello", 100, 100 )             -- Text will be drawn at 100,100
        dxSetAspectRatioAdjustmentEnabled( true )
        dxDrawText("Goodbye", 100, 100 )           -- Text will be drawn at some adjusted position
    end
)

@@ Line 4: / Line 4: @@
 {{New feature/item|3.0140|1.3.3|5547|
-Todo. This function is default enabled for the ''customblips'' resource and does only works during these events: onClientRender, onClientPreRender and onClientHUDRender
+This function should be used when aligning the output of dxDraw calls with GTA HUD components. It can only be called during these events: onClientRender, onClientPreRender and onClientHUDRender, and is automatically disabled when these events return. So the function has to be called every frame, just like dxDraws.
 }}
@@ Line 17: / Line 17: @@
 ===Optional Arguments===
 {{OptionalArg}}
-* '''fSourceRatio :''' Todo.
+* '''fSourceRatio :''' This should be set to the aspect ratio the dxDraw were originally designed with.
 ===Returns===
-Returns ''true'' when the it was changed successfully, or ''false'' otherwise.
+Returns ''true'' when it was changed successfully, or ''false'' otherwise.
 ==Requirements==
@@ Line 27: / Line 27: @@
 ==Example==
 <syntaxhighlight lang="lua">
--- Todo
+addEventHandler("onClientRender",root,
+    function()
+        dxDrawText("Hello", 100, 100 )             -- Text will be drawn at 100,100
+        dxSetAspectRatioAdjustmentEnabled( true )
+        dxDrawText("Goodbye", 100, 100 )           -- Text will be drawn at some adjusted position
+    end
+)
 </syntaxhighlight>
 ==See Also==
 {{Drawing_functions}}