Frame:CreateMaskTexture

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Links
Blizzard Docs FrameXML  GitHub Search

Creates a mask texture.

maskTexture = Frame:CreateMaskTexture([name, drawLayer, templateName, subLevel])

Arguments

name

string?

drawLayer

string? : DrawLayer

templateName

string?

subLevel

number?

Returns

maskTexture

MaskTexture🔗

Example

Applies a circle texture mask.

local f = CreateFrame("Frame", nil, UIParent)
f:SetPoint("CENTER")
f:SetSize(32, 32)

f.tex = f:CreateTexture(nil, "ARTWORK")
f.tex:SetAllPoints(f)
f.tex:SetTexture("Interface/Tooltips/UI-Tooltip-Background")
f.tex:SetColorTexture(0, 0, 0, 0.5) -- black, 50% opacity

f.mask = f:CreateMaskTexture()
f.mask:SetAllPoints(f.tex)
f.mask:SetTexture("Interface/CHARACTERFRAME/TempPortraitAlphaMask", "CLAMPTOBLACKADDITIVE", "CLAMPTOBLACKADDITIVE")
f.tex:AddMaskTexture(f.mask)

Patch changes

Patch 7.2.0 (2017-03-28): Added.

See also

• Frame:CreateTexture
• TextureBase:SetMask