axmol/cocos/scripting/lua-bindings/auto/api/GridBase.lua

145 lines
4.4 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module GridBase
-- @extend Ref
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the size of the grid.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] setGridSize
-- @param self
-- @param #size_table gridSize
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#GridBase] afterBlit
2014-03-10 14:04:58 +08:00
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] afterDraw
-- @param self
-- @param #cc.Node target
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @{<br>
-- Init and reset the status when render effects by using the grid.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] beforeDraw
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Interface, Calculate the vertices used for the blit.
-- @function [parent=#GridBase] calculateVertexPoints
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- is texture flipped.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] isTextureFlipped
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Size of the grid.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] getGridSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- Pixels between the grids.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] getStep
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Change projection to 2D for grabbing.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] set2DProjection
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get the pixels between the grids.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] setStep
-- @param self
-- @param #vec2_table step
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the texture flipped or not.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] setTextureFlipped
-- @param self
-- @param #bool flipped
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Interface used to blit the texture with grid to screen.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] blit
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] setActive
-- @param self
-- @param #bool active
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get number of times that the grid will be reused.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] getReuseGrid
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- @overload self, size_table
-- @overload self, size_table, cc.Texture2D, bool
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] initWithSize
-- @param self
-- @param #size_table gridSize
-- @param #cc.Texture2D texture
-- @param #bool flipped
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @{<br>
-- Interface for custom action when before or after draw.
-- @function [parent=#GridBase] beforeBlit
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set number of times that the grid will be reused.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] setReuseGrid
-- @param self
-- @param #int reuseGrid
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @} @{<br>
-- Getter and setter of the active state of the grid.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] isActive
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Interface, Reuse the grid vertices.
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] reuse
-- @param self
-- @return GridBase#GridBase self (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @overload self, size_table
-- @overload self, size_table, cc.Texture2D, bool
2014-03-10 14:04:58 +08:00
-- @function [parent=#GridBase] create
-- @param self
-- @param #size_table gridSize
-- @param #cc.Texture2D texture
-- @param #bool flipped
-- @return GridBase#GridBase ret (return value: cc.GridBase)
2014-03-10 14:04:58 +08:00
return nil