DxSetAspectRatioAdjustmentEnabled: Difference between revisions
No edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
{{New feature/item|3.0140|1.3.3|5547| | {{New feature/item|3.0140|1.3.3|5547| | ||
This function | This function temporarily allows for the positioning of GUI and dxDraw calls to be automatically adjusted according to the client's aspect ratio setting. This lasts for a single execution of an event handler for one of the following events: [[onClientRender]], [[onClientPreRender]] and [[onClientHUDRender]]. So the function has to be called every frame, just like dxDraws. | ||
}} | }} | ||
Line 16: | Line 16: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
* '''sourceRatio :''' This should be set to the aspect ratio the | * '''sourceRatio :''' This should be set to the aspect ratio the dxDraws were originally designed in. | ||
===Returns=== | ===Returns=== |
Revision as of 00:05, 27 June 2013
This function temporarily allows for the positioning of GUI and dxDraw calls to be automatically adjusted according to the client's aspect ratio setting. This lasts for a single execution of an event handler for one of the following events: onClientRender, onClientPreRender and onClientHUDRender. So the function has to be called every frame, just like dxDraws.
Syntax
bool dxSetAspectRatioAdjustmentEnabled ( bool bEnabled [, float sourceRatio = 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.
- sourceRatio : This should be set to the aspect ratio the dxDraws were originally designed in.
Returns
Returns true when it was changed successfully, or false otherwise.
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.3.3-9.05547 |
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.3-9.05547" />
Example
scx,scy = guiGetScreenSize() addEventHandler( "onClientRender", root, function() dxDrawText( "Hello", 300, 300 ) -- Text will be drawn at 300,300 dxSetAspectRatioAdjustmentEnabled( true ) dxDrawText( "Goodbye", 0.78*scx, 0.22*scy ) -- Text will be drawn just below HUD money, with any aspect ratio end )
See Also
- dxConvertPixels
- dxCreateFont
- dxCreateRenderTarget
- dxCreateScreenSource
- dxCreateShader
- dxCreateTexture
- dxDrawCircle
- dxDrawImage
- dxDrawImageSection
- dxDrawLine
- dxDrawLine3D
- dxDrawMaterialLine3D
- dxDrawMaterialPrimitive
- dxDrawMaterialPrimitive3D
- dxDrawMaterialSectionLine3D
- dxDrawPrimitive
- dxDrawPrimitive3D
- dxDrawRectangle
- dxDrawText
- dxDrawWiredSphere
- dxGetBlendMode
- dxGetFontHeight
- dxGetMaterialSize
- dxGetPixelColor
- dxGetPixelsSize
- dxGetPixelsFormat
- dxGetStatus
- dxGetTextSize
- dxGetTextWidth
- dxGetTexturePixels
- dxIsAspectRatioAdjustmentEnabled
- dxSetAspectRatioAdjustmentEnabled
- dxSetBlendMode
- dxSetPixelColor
- dxSetRenderTarget
- dxSetShaderValue
- dxSetShaderTessellation
- dxSetShaderTransform
- dxSetTestMode
- dxSetTextureEdge
- dxSetTexturePixels
- dxUpdateScreenSource