EngineApplyShaderToWorldTexture: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(added examples)
m (typo)
Line 72: Line 72:
</syntaxhighlight>
</syntaxhighlight>


Basic texture replacement shader example (compatible with all examples on this page):
Basic texture replacement shader example (compatible with all script examples on this page):
<syntaxhighlight lang="fx">
<syntaxhighlight lang="fx">
texture gTexture;
texture gTexture;

Revision as of 21:05, 23 October 2018

This function applies a shader to one or more world textures.

[[{{{image}}}|link=|]] Tip:
  • The resource shader_tex_names can help in finding the names of world textures.
  • When replacing the texture for a ped using the CJ skin, set textureName to "CJ"
  • The shader inherits the render states of the original when it is drawn, so texture stage 0 will already be set to the original texture.
  • When using with a 'ped', ensure you have set 'ped' or 'all' in the elementTypes when calling dxCreateShader
  • CJ body parts textures can be replaced by using: "cj_ped_head", "cj_ped_hat", "cj_ped_torso", "cj_ped_legs", "cj_ped_feet", "cj_ped_glasses", "cj_ped_necklace", "cj_ped_watch" and "cj_ped_extra1". Latest version of shader_tex_names will show what is being used.

Syntax

bool engineApplyShaderToWorldTexture ( element shader, string textureName [, element targetElement = nil, bool appendLayers = true ] )

OOP Syntax Help! I don't understand this!

Method: shader:applyToWorldTexture(...)

Required Arguments

  • shader: The shader which is to be applied
  • textureName: The name of the world texture to apply the shader to. Wildcard matching e.g. "ro?ds*" can be used to apply to more than one texture at a time.

Optional Arguments

  • targetElement: The element to restrict applying the shader to. If this is not set the shader will be applied to everything using the texture name. Valid element types for targetElement are vehicles, objects and peds.
  • appendLayers: allows two or more layered shaders to be applied in the same texture. You may want to modify the DepthBias in the technique pass to avoid Z-fighting artifacts when using this.

Returns

Returns true if the shader was successfully applied, false otherwise.

Example

This example will replace the texture of a group of common explosions (grenades, rockets, etc) with a custom explosion effect 

theTechnique = dxCreateShader("shader.fx")
explosionTexture = dxCreateTexture( "tex/Explosion.png")

function replaceEffect()
	engineApplyShaderToWorldTexture(theTechnique, "fireball6")
	dxSetShaderValue (theTechnique, "gTexture", explosionTexture)
end
addEventHandler("onClientResourceStart",resourceRoot,replaceEffect)

This example will apply a shader to the "des_logwall" world texture (which is used by the house near the 'play' gamemode spawn point) 

myShader = dxCreateShader( "hello.fx" )
engineApplyShaderToWorldTexture( myShader, "des_logwall" )

This untested example will apply a shader to the current vehicle of the local player 

myShader = dxCreateShader( "hello.fx" )

addEventHandler("onClientVehicleEnter", root,
    function(thePlayer, seat)
        local theVehicle = source
        if seat == 0 and thePlayer == localPlayer then
            engineApplyShaderToWorldTexture( myShader, "vehiclegrunge256", theVehicle )
            engineApplyShaderToWorldTexture( myShader, "?emap*", theVehicle )
        end
    end
)

addEventHandler("onClientVehicleExit", root,
    function(thePlayer, seat)
        local theVehicle = source
        if seat == 0 and thePlayer == localPlayer then
            engineRemoveShaderFromWorldTexture( myShader, "vehiclegrunge256", theVehicle )
            engineRemoveShaderFromWorldTexture( myShader, "?emap*", theVehicle )
        end
    end
)

Basic texture replacement shader example (compatible with all script examples on this page): 

texture gTexture;

technique TexReplace
{
    pass P0
    {
        Texture[0] = gTexture;
    }
}

Changelog

Version Description
1.3.0-9.04140 Added targetElement argument
1.3.0-9.04418 Added peds to allowed element types (for pixel shaders only)
1.3.1-9.04939 Added peds to allowed element types (full support)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/EngineApplyShaderToWorldTexture?oldid=60013"