mirror of https://github.com/axmolengine/axmol.git
112 lines
4.2 KiB
Lua
112 lines
4.2 KiB
Lua
|
|
--------------------------------
|
|
-- @module ClippingNode
|
|
-- @extend Node
|
|
-- @parent_module cc
|
|
|
|
--------------------------------
|
|
-- If stencil has no children it will not be drawn.<br>
|
|
-- If you have custom stencil-based node with stencil drawing mechanics other then children-based,<br>
|
|
-- then this method should return true every time you wish stencil to be visited.<br>
|
|
-- By default returns true if has any children attached.<br>
|
|
-- return If you have custom stencil-based node with stencil drawing mechanics other then children-based,<br>
|
|
-- then this method should return true every time you wish stencil to be visited.<br>
|
|
-- By default returns true if has any children attached.<br>
|
|
-- js NA
|
|
-- @function [parent=#ClippingNode] hasContent
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Set the ClippingNode whether or not invert.<br>
|
|
-- param inverted A bool Type,to set the ClippingNode whether or not invert.
|
|
-- @function [parent=#ClippingNode] setInverted
|
|
-- @param self
|
|
-- @param #bool inverted
|
|
-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
-- Set the Node to use as a stencil to do the clipping.<br>
|
|
-- param stencil The Node to use as a stencil to do the clipping.
|
|
-- @function [parent=#ClippingNode] setStencil
|
|
-- @param self
|
|
-- @param #cc.Node stencil
|
|
-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
-- The alpha threshold.<br>
|
|
-- The content is drawn only where the stencil have pixel with alpha greater than the alphaThreshold.<br>
|
|
-- Should be a float between 0 and 1.<br>
|
|
-- This default to 1 (so alpha test is disabled).<br>
|
|
-- return The alpha threshold value,Should be a float between 0 and 1.
|
|
-- @function [parent=#ClippingNode] getAlphaThreshold
|
|
-- @param self
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Initializes a clipping node with an other node as its stencil.<br>
|
|
-- The stencil node will be retained, and its parent will be set to this clipping node.
|
|
-- @function [parent=#ClippingNode] init
|
|
-- @param self
|
|
-- @param #cc.Node stencil
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- The Node to use as a stencil to do the clipping.<br>
|
|
-- The stencil node will be retained.<br>
|
|
-- This default to nil.<br>
|
|
-- return The stencil node.
|
|
-- @function [parent=#ClippingNode] getStencil
|
|
-- @param self
|
|
-- @return Node#Node ret (return value: cc.Node)
|
|
|
|
--------------------------------
|
|
-- Set the alpha threshold. <br>
|
|
-- param alphaThreshold The alpha threshold.
|
|
-- @function [parent=#ClippingNode] setAlphaThreshold
|
|
-- @param self
|
|
-- @param #float alphaThreshold
|
|
-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
-- Inverted. If this is set to true,<br>
|
|
-- the stencil is inverted, so the content is drawn where the stencil is NOT drawn.<br>
|
|
-- This default to false.<br>
|
|
-- return If the clippingNode is Inverted, it will be return true.
|
|
-- @function [parent=#ClippingNode] isInverted
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- @overload self, cc.Node
|
|
-- @overload self
|
|
-- @function [parent=#ClippingNode] create
|
|
-- @param self
|
|
-- @param #cc.Node stencil
|
|
-- @return ClippingNode#ClippingNode ret (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#ClippingNode] setCameraMask
|
|
-- @param self
|
|
-- @param #unsigned short mask
|
|
-- @param #bool applyChildren
|
|
-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#ClippingNode] visit
|
|
-- @param self
|
|
-- @param #cc.Renderer renderer
|
|
-- @param #mat4_table parentTransform
|
|
-- @param #unsigned int parentFlags
|
|
-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode)
|
|
|
|
--------------------------------
|
|
-- Initializes a clipping node without a stencil.
|
|
-- @function [parent=#ClippingNode] init
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
return nil
|