SetNearClipDistance: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Documented the function added in r6948)
 
No edit summary
 
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0141|1.4.1|6948|This function sets the distance from the [[camera]] at which the world starts rendering. It can be used in many ways, including: reducing Z-fighting, creating more sophisticated first person views, allowing the camera to fly closer to the ground without passing through it, etcetera.}}
{{New feature/item|3.0141|1.4.1|6948|This function sets the distance from the [[camera]] at which the world starts rendering. Do not use this function unless you have a specific reason to do so, as any values can cause artifacts and flickering problems. It can be used in many ways, including: reducing Z-fighting, creating more sophisticated first person views, allowing the camera to fly closer to the ground without passing through it, etcetera.}}


{{Note|To avoid problems, the near clip distance should be smaller than the [[setFarClipDistance|far clip distance]]. Also, setting very high near clip distances while the camera is near objects causes graphical artifacts.}}
{{Note|[[setNearClipDistance]] should only be used when the camera orientation is controlled by [[setCameraMatrix]], because GTA automatically adjusts this value for the optimum setting when the camera is attached to a player. Therefore ensure [[resetNearClipDistance]] is called when returning camera control back to GTA.}}


==Syntax==  
==Syntax==  

Latest revision as of 20:25, 27 November 2014

This function sets the distance from the camera at which the world starts rendering. Do not use this function unless you have a specific reason to do so, as any values can cause artifacts and flickering problems. It can be used in many ways, including: reducing Z-fighting, creating more sophisticated first person views, allowing the camera to fly closer to the ground without passing through it, etcetera.

[[{{{image}}}|link=|]] Note: setNearClipDistance should only be used when the camera orientation is controlled by setCameraMatrix, because GTA automatically adjusts this value for the optimum setting when the camera is attached to a player. Therefore ensure resetNearClipDistance is called when returning camera control back to GTA.

Syntax

bool setNearClipDistance ( float distance )

Required arguments

  • distance: the new near clip distance. It must be between 0.1 and 20 for the function to do any effect. Default value is 0.3.

Returns

This function returns true if the argument is valid. Returns false otherwise.

Example

This example allows the camera to be nearer to ground level without viewing what is under it. 

setNearClipDistance(0.1) -- Start rendering things three times nearer than usual to archieve the effect described above

See also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetNearClipDistance?oldid=43111"