dxDrawMaterialPrimitive | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

dxDrawMaterialPrimitive

Client-side
Server-side
Shared

This function draws a 2D primitive shape with material applied to it across the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.

If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring. Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...

Syntax 

​bool dxDrawMaterialPrimitive ( ​string pType, ​string/​texture material, ​string name, ​table vertex1, [ ​table vertex2... = nil ] )
Required Arguments
  • pType: Type of primitive to be drawn. More info on MSDN site.
    • pointlist: Renders the vertices as a collection of isolated points.
    • linelist: Renders the vertices as a list of isolated straight line segments.
    • linestrip: Renders the vertices as a single polyline.
    • trianglelist: Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
    • trianglestrip: Renders the vertices as a triangle strip.
    • trianglefan: Renders the vertices as a triangle fan.
  • material: Either a texture element or a filepath of the image which is going to be drawn. Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with dxCreateTexture to speed up drawing.
  • name: A string representing a stage at which the actual drawcall should happen.
    • prefx: Primitives are rendered before the color correction. This stage makes lines look natural to SA but colors could be distorted.
    • postfx: Primitives are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.
    • postgui: Primitives are rendered after GUI. The line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
  • vertex1: Tables representing each primitive vertex, required amount of them is determined by primitive type. See vertices format below:
    • posX - An float representing the absolute X position of the vertex, represented by pixels on the screen.
    • posY - An float representing the absolute Y position of the vertex, represented by pixels on the screen.
    • color (optional) - An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.
    • u - An float representing the relative X coordinate of the top left corner of the material which should be drawn from image.
    • v - An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • vertex2... (default: nil): Tables representing each primitive vertex, required amount of them is determined by primitive type. Check table format above.

Returns

  • bool: result

Returns a true if the operation was successful, false otherwise.

Code Examples

client 
-- Load the texture
local texture = dxCreateTexture("myTexture.png")


-- Function to render a textured triangle
function renderPrimitive()
    if (texture) then
        -- Draw the primitive using the "trianglelist" type
        -- 3 vertices, each with 4 numbers: {x, y, u, v}
        dxDrawMaterialPrimitive("trianglelist", texture, false, {100, 100, 0, 0}, {300, 100, 1, 0}, {200, 300, 0.5, 1})
    end
end


-- Add an event handler to render the primitive every frame
addEventHandler("onClientRender", root, renderPrimitive)

See Also

Drawing Functions
Drawing Elements
Reference