DxGetStatus: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Options -> Settings)
 
(22 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function gets information about various internal datum
This function gets information about various internal datum.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table dxGetStatus ()
table dxGetStatus ( )
</syntaxhighlight>  
</syntaxhighlight>  


===Returns===
===Returns===
Returns a table with the following entries:
Returns a table with the following entries:
* '''TestMode :''' The current dx test mode. See [[dxSetTestMode]].
*'''TestMode:''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName :''' The name of the graphics card.
*'''VideoCardName:''' The name of the graphics card.
*'''VideoCardRAM :''' The installed memory in MB of the graphics card.
*'''VideoCardRAM:''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion :''' The maximum pixel shader version of the graphics card.
*'''VideoCardPSVersion:''' The maximum pixel shader version of the graphics card.
*'''VideoMemoryFreeForMTA :''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''VideoMemoryUsedByFonts :''' The amount of graphic memory in MB used by custom fonts.
*'''VideoCardNumRenderTargets:''' The maximum number of simultaneous render targets a shader can use.
*'''VideoMemoryUsedByTextures :''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryFreeForMTA:''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByRenderTargets :''' The amount of graphic memory in MB used by render targets.
*'''VideoMemoryUsedByFonts:''' The amount of graphic memory in MB used by custom fonts.
*'''SettingWindowed :''' The windowed setting. (true/false)
*'''VideoMemoryUsedByTextures:''' The amount of graphic memory in MB used by textures.
*'''SettingFXQuality :''' The FX Quality. (0-3)
*'''VideoMemoryUsedByRenderTargets:''' The amount of graphic memory in MB used by render targets.
*'''SettingDrawDistance :''' The draw distance setting. (0-100)
*'''SettingWindowed:''' The windowed setting. (true/false)
*'''SettingVolumetricShadows :''' The volumetric shadows setting. (true/false)
*'''SettingFullScreenStyle:''' Display style when in full screen mode. (0-2 which respectively mean: Standard, Borderless window, Borderless keep res)
*'''SettingStreamingVideoMemoryForGTA :''' The usable graphics memory setting. (64-256)
*'''SettingFXQuality:''' The FX Quality. (0-3)
*'''AllowScreenUpload :''' The allows screen uploads setting. (true/false)
*'''SettingDrawDistance:''' The draw distance setting. (0-100)
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available
*'''SettingVolumetricShadows:''' The volumetric shadows setting. (true/false)
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingStreamingVideoMemoryForGTA:''' The usable graphics memory setting. (64-256)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off,2x,4x,8x,16x)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off,1x,2x,3x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off, 1x, 2x, 3x)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)
{{New feature/item|3.0134|1.3.4|5731|
*'''SettingHUDMatchAspectRatio:''' The hud match aspect ratio setting. (true/false)
*'''SettingHUDMatchAspectRatio:''' The hud match aspect ratio setting (true/false)
*'''SettingAspectRatio:''' The aspect ratio setting. ("auto", "4:3", "16:10", "16:9")
*'''SettingAspectRatio:''' The aspect ratio setting ("auto", "4:3", "16:10", "16:9")
*'''SettingFOV:''' The FOV setting.
*'''SettingHighDetailVehicles:''' High detail vehicles setting. (true/false)
{{Added feature/item|1.5.9|1.5.8|20508|
*'''SettingHighDetailPeds:''' High detail peds setting. (true/false)
}}
{{Added feature/item|1.5.9|1.5.8|21251|
*'''SettingCoronaReflections:''' Corona rain reflections setting. (true/false)
}}
{{Added feature/item|1.5.9|1.5.8|21348|
*'''SettingDynamicPedShadows:''' Dynamic ped shadows setting. (true/false)
}}
*'''AllowScreenUpload:''' The allows screen uploads setting. (true/false)
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available.
{{Added feature/item|1.5.9|1.5.8|20901|
*'''TotalPhysicalMemory:''' The amount of total physical memory in MB.
}}
*'''UsingDepthBuffer:''' ''true'' if the depth buffer is used, ''false'' otherwise.
{{Added feature/item|1.6.0|1.5.9|21785|
*'''SettingDebugMode:''' Selected option in Settings -> Advanced tab -> Debug setting ("Default", "#6734 Graphics", "#6732 D3D", "#0000 Log timing", "#0000 Joystick", "#0000 Lua trace", "#0000 Resize always", "#0000 Resize never")
}}
}}
==Example==
==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "getinfo",
addCommandHandler("getinfo",
function ( )
function ()
local info = dxGetStatus()
local info = dxGetStatus ()
for k, v in pairs ( info ) do
for k, v in pairs (info) do
outputChatBox ( k .. " : " .. tostring ( v ) )
outputChatBox (k .. " : " .. tostring (v))
end
end
end
end
)
)
</syntaxhighlight>
</syntaxhighlight>
</section>


==Changelog==
==Changelog==
Line 55: Line 70:
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br/> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br/> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}
{{ChangelogItem|1.3.4-9.05731|Added SettingHUDMatchAspectRatio and SettingAspectRatio}}
{{ChangelogItem|1.3.4-9.05731|Added SettingHUDMatchAspectRatio and SettingAspectRatio}}
{{ChangelogItem|1.4.1-9.07181|Added SettingFOV}}
{{ChangelogItem|1.4.1-9.07310|Added VideoCardNumRenderTargets}}
{{ChangelogItem|1.5.2-9.07816|Added UsingDepthBuffer}}
{{ChangelogItem|1.5.3-9.11199|Added SettingHighDetailVehicles}}
{{ChangelogItem|1.5.5-9.11814|Added SettingFullScreenStyle<br/>Fixed SettingWindowed}}
{{ChangelogItem|1.5.8-9.20508|Added SettingHighDetailPeds}}
{{ChangelogItem|1.5.8-9.20901|Added TotalPhysicalMemory}}
{{ChangelogItem|1.6.0-9.21785|Added SettingDebugMode}}


==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[hu:dxGetStatus]]

Latest revision as of 04:11, 3 May 2023

This function gets information about various internal datum.

Syntax

table dxGetStatus ( )

Returns

Returns a table with the following entries:

  • TestMode: The current dx test mode. See dxSetTestMode.
  • VideoCardName: The name of the graphics card.
  • VideoCardRAM: The installed memory in MB of the graphics card.
  • VideoCardPSVersion: The maximum pixel shader version of the graphics card.
  • VideoCardMaxAnisotropy: The maximum anisotropic filtering available. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
  • VideoCardNumRenderTargets: The maximum number of simultaneous render targets a shader can use.
  • VideoMemoryFreeForMTA: The amount of memory in MB available for MTA to use. When this gets to zero, guiCreateFont, dxCreateFont and dxCreateRenderTarget will fail.
  • VideoMemoryUsedByFonts: The amount of graphic memory in MB used by custom fonts.
  • VideoMemoryUsedByTextures: The amount of graphic memory in MB used by textures.
  • VideoMemoryUsedByRenderTargets: The amount of graphic memory in MB used by render targets.
  • SettingWindowed: The windowed setting. (true/false)
  • SettingFullScreenStyle: Display style when in full screen mode. (0-2 which respectively mean: Standard, Borderless window, Borderless keep res)
  • SettingFXQuality: The FX Quality. (0-3)
  • SettingDrawDistance: The draw distance setting. (0-100)
  • SettingVolumetricShadows: The volumetric shadows setting. (true/false)
  • SettingStreamingVideoMemoryForGTA: The usable graphics memory setting. (64-256)
  • SettingAnisotropicFiltering: The anisotropic filtering setting. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
  • SettingAntiAliasing: The anti-aliasing setting. (0-3 which respectively mean: off, 1x, 2x, 3x)
  • SettingHeatHaze: The heat haze setting. (true/false)
  • SettingGrassEffect: The grass effect setting. (true/false)
  • Setting32BitColor: The color depth of the screen. (false is 16bit, true is 32bit)
  • SettingHUDMatchAspectRatio: The hud match aspect ratio setting. (true/false)
  • SettingAspectRatio: The aspect ratio setting. ("auto", "4:3", "16:10", "16:9")
  • SettingFOV: The FOV setting.
  • SettingHighDetailVehicles: High detail vehicles setting. (true/false)
  • SettingHighDetailPeds: High detail peds setting. (true/false)
  • SettingCoronaReflections: Corona rain reflections setting. (true/false)
  • SettingDynamicPedShadows: Dynamic ped shadows setting. (true/false)
  • AllowScreenUpload: The allows screen uploads setting. (true/false)
  • DepthBufferFormat: The format of the shader readable depth buffer, or 'unknown' if not available.
  • TotalPhysicalMemory: The amount of total physical memory in MB.
  • UsingDepthBuffer: true if the depth buffer is used, false otherwise.
  • SettingDebugMode: Selected option in Settings -> Advanced tab -> Debug setting ("Default", "#6734 Graphics", "#6732 D3D", "#0000 Log timing", "#0000 Joystick", "#0000 Lua trace", "#0000 Resize always", "#0000 Resize never")

Example

addCommandHandler("getinfo",
	function ()
		local info = dxGetStatus ()
		for k, v in pairs (info) do
			outputChatBox (k .. " : " .. tostring (v))
		end
	end
)

Changelog

Version Description
1.3.0-9.04715 Added DepthBufferFormat argument
1.3.0-9.04811 Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,
SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments
1.3.4-9.05731 Added SettingHUDMatchAspectRatio and SettingAspectRatio
1.4.1-9.07181 Added SettingFOV
1.4.1-9.07310 Added VideoCardNumRenderTargets
1.5.2-9.07816 Added UsingDepthBuffer
1.5.3-9.11199 Added SettingHighDetailVehicles
1.5.5-9.11814 Added SettingFullScreenStyle
Fixed SettingWindowed
1.5.8-9.20508 Added SettingHighDetailPeds
1.5.8-9.20901 Added TotalPhysicalMemory
1.6.0-9.21785 Added SettingDebugMode

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/DxGetStatus?oldid=76812"