137 lines
5.3 KiB
Lua
137 lines
5.3 KiB
Lua
---@meta
|
|
|
|
---@class Texture : TextureBase
|
|
Texture = {
|
|
--- Adds a mask texture to the texture.
|
|
--- @param mask Texture The mask texture to add.
|
|
--- @example
|
|
--- myTexture:AddMaskTexture(myMaskTexture)
|
|
AddMaskTexture = function(self, mask) end,
|
|
|
|
--- Returns the mask texture at the specified index.
|
|
--- @param index number The index of the mask texture.
|
|
--- @return Texture mask The mask texture at the specified index.
|
|
--- @example
|
|
--- local mask = myTexture:GetMaskTexture(1)
|
|
GetMaskTexture = function(self, index) end,
|
|
|
|
--- Returns the number of mask textures applied to the texture.
|
|
--- @return number count The number of mask textures.
|
|
--- @example
|
|
--- local count = myTexture:GetNumMaskTextures()
|
|
GetNumMaskTextures = function(self) end,
|
|
|
|
--- Removes a mask texture from the texture.
|
|
--- @param mask Texture The mask texture to remove.
|
|
--- @example
|
|
--- myTexture:RemoveMaskTexture(myMaskTexture)
|
|
RemoveMaskTexture = function(self, mask) end,
|
|
|
|
--- Sets the texture to an atlas.
|
|
--- @param atlas string The atlas to set.
|
|
--- @param useAtlasSize boolean? Optional. Whether to use the atlas size.
|
|
--- @param filterMode string? Optional. The filter mode to use.
|
|
--- @param resetTexCoords boolean? Optional. Whether to reset texture coordinates.
|
|
--- @example
|
|
--- myTexture:SetAtlas("MyAtlas", true)
|
|
SetAtlas = function(self, atlas, useAtlasSize, filterMode, resetTexCoords) end,
|
|
|
|
--- Sets the blend mode of the texture.
|
|
--- @param blendMode string The blend mode to set.
|
|
--- @example
|
|
--- myTexture:SetBlendMode("ADD")
|
|
SetBlendMode = function(self, blendMode) end,
|
|
|
|
--- Sets the texture to a solid color.
|
|
--- @param colorR number The red component of the color.
|
|
--- @param colorG number The green component of the color.
|
|
--- @param colorB number The blue component of the color.
|
|
--- @param a number? Optional. The alpha component of the color.
|
|
--- @example
|
|
--- myTexture:SetColorTexture(1, 0, 0) -- Set to red
|
|
SetColorTexture = function(self, colorR, colorG, colorB, a) end,
|
|
|
|
--- Sets the texture to be desaturated.
|
|
--- @param desaturated boolean? Optional. True to desaturate the texture.
|
|
--- @example
|
|
--- myTexture:SetDesaturated(true)
|
|
SetDesaturated = function(self, desaturated) end,
|
|
|
|
--- Sets the desaturation level of the texture.
|
|
--- @param desaturation number The desaturation level to set.
|
|
--- @example
|
|
--- myTexture:SetDesaturation(0.5) -- Set to 50% desaturation
|
|
SetDesaturation = function(self, desaturation) end,
|
|
|
|
--- Sets a gradient color shading for the texture.
|
|
--- @param orientation string The orientation of the gradient.
|
|
--- @param minColor table The minimum color.
|
|
--- @param maxColor table The maximum color.
|
|
--- @example
|
|
--- myTexture:SetGradient("HORIZONTAL", {1, 0, 0}, {0, 0, 1}) -- Red to Blue
|
|
SetGradient = function(self, orientation, minColor, maxColor) end,
|
|
|
|
--- Sets whether the texture should tile horizontally.
|
|
--- @param tiling boolean? Optional. True to enable horizontal tiling.
|
|
--- @example
|
|
--- myTexture:SetHorizTile(true)
|
|
SetHorizTile = function(self, tiling) end,
|
|
|
|
--- Applies a mask to the texture.
|
|
--- @param file string The file path of the mask.
|
|
--- @example
|
|
--- myTexture:SetMask("Interface\\Textures\\Mask")
|
|
SetMask = function(self, file) end,
|
|
|
|
--- Applies a rotation to the texture.
|
|
--- @param radians number The rotation in radians.
|
|
--- @param normalizedRotationPoint table? Optional. The normalized rotation point.
|
|
--- @example
|
|
--- myTexture:SetRotation(math.rad(45)) -- Rotate 45 degrees
|
|
SetRotation = function(self, radians, normalizedRotationPoint) end,
|
|
|
|
--- Sets the texture to snap to the pixel grid.
|
|
--- @param snap boolean? Optional. True to enable snapping.
|
|
--- @example
|
|
--- myTexture:SetSnapToPixelGrid(true)
|
|
SetSnapToPixelGrid = function(self, snap) end,
|
|
|
|
--- Sets the coordinates for cropping or transforming the texture.
|
|
--- @param left number The left coordinate.
|
|
--- @param right number The right coordinate.
|
|
--- @param bottom number The bottom coordinate.
|
|
--- @param top number The top coordinate.
|
|
--- @example
|
|
--- myTexture:SetTexCoord(0, 1, 0, 1) -- Full texture
|
|
SetTexCoord = function(self, left, right, bottom, top) end,
|
|
|
|
--- Sets the texel snapping bias for the texture.
|
|
--- @param bias number The texel snapping bias to set.
|
|
--- @example
|
|
--- myTexture:SetTexelSnappingBias(0.5)
|
|
SetTexelSnappingBias = function(self, bias) end,
|
|
|
|
--- Sets the texture to an image.
|
|
--- @param textureAsset string The texture asset to set.
|
|
--- @param wrapModeHorizontal string? Optional. The horizontal wrap mode.
|
|
--- @param wrapModeVertical string? Optional. The vertical wrap mode.
|
|
--- @param filterMode string? Optional. The filter mode.
|
|
--- @example
|
|
--- myTexture:SetTexture("Interface\\Textures\\MyTexture")
|
|
SetTexture = function(self, textureAsset, wrapModeHorizontal, wrapModeVertical, filterMode) end,
|
|
|
|
--- Sets whether the texture should tile vertically.
|
|
--- @param tiling boolean? Optional. True to enable vertical tiling.
|
|
--- @example
|
|
--- myTexture:SetVertTile(true)
|
|
SetVertTile = function(self, tiling) end,
|
|
|
|
--- Sets a vertex offset for the texture.
|
|
--- @param vertexIndex number The index of the vertex.
|
|
--- @param offsetX number The x offset to set.
|
|
--- @param offsetY number The y offset to set.
|
|
--- @example
|
|
--- myTexture:SetVertexOffset(1, 5, 5)
|
|
SetVertexOffset = function(self, vertexIndex, offsetX, offsetY) end,
|
|
}
|