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

158 lines
5.5 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module SpriteFrame
-- @extend Ref
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] clone
-- @param self
-- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame)
--------------------------------
-- Set rotated of the sprite frame.<br>
-- param rotated Rotated the sprite frame if true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setRotated
-- @param self
-- @param #bool rotated
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set texture of the frame, the texture is retained.<br>
-- param pobTexture The texture of the sprite frame.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setTexture
-- @param self
-- @param #cc.Texture2D pobTexture
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get offset of the frame.<br>
-- return The offset of the sprite frame.
-- @function [parent=#SpriteFrame] getOffset
2014-03-10 14:04:58 +08:00
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set rect of the sprite frame.<br>
-- param rectInPixels The rect of the sprite frame, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setRectInPixels
-- @param self
-- @param #rect_table rectInPixels
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get texture of the frame.<br>
-- return The texture of the sprite frame.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getTexture
-- @param self
-- @return Texture2D#Texture2D ret (return value: cc.Texture2D)
--------------------------------
-- Get rect of the frame.<br>
-- return The rect of the sprite frame.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getRect
-- @param self
-- @return rect_table#rect_table ret (return value: rect_table)
--------------------------------
-- Set offset of the frame.<br>
-- param offsetInPixels The offset of the sprite frame, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setOffsetInPixels
-- @param self
-- @param #vec2_table offsetInPixels
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get rect of the sprite frame.<br>
-- return The rect of the sprite frame, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getRectInPixels
-- @param self
-- @return rect_table#rect_table ret (return value: rect_table)
--------------------------------
-- Set original size of the trimmed image.<br>
-- param sizeInPixels The original size of the trimmed image.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setOriginalSize
-- @param self
-- @param #size_table sizeInPixels
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get original size of the trimmed image.<br>
-- return The original size of the trimmed image, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getOriginalSizeInPixels
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- Set original size of the trimmed image.<br>
-- param sizeInPixels The original size of the trimmed image, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setOriginalSizeInPixels
-- @param self
-- @param #size_table sizeInPixels
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set offset of the frame.<br>
-- param offsets The offset of the sprite frame.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setOffset
-- @param self
-- @param #vec2_table offsets
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Is the sprite frame rotated or not.<br>
-- return Is rotated if true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] isRotated
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Set rect of the frame.<br>
-- param The rect of the sprite.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] setRect
-- @param self
-- @param #rect_table rect
-- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get offset of the frame.<br>
-- return The offset of the sprite frame, in pixels.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getOffsetInPixels
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get original size of the trimmed image.<br>
-- return The original size of the trimmed image.
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] getOriginalSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- @overload self, string, rect_table, bool, vec2_table, size_table
-- @overload self, string, rect_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] create
-- @param self
-- @param #string filename
2014-03-10 14:04:58 +08:00
-- @param #rect_table rect
-- @param #bool rotated
-- @param #vec2_table offset
-- @param #size_table originalSize
-- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @overload self, cc.Texture2D, rect_table, bool, vec2_table, size_table
-- @overload self, cc.Texture2D, rect_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#SpriteFrame] createWithTexture
-- @param self
-- @param #cc.Texture2D pobTexture
2014-03-10 14:04:58 +08:00
-- @param #rect_table rect
-- @param #bool rotated
-- @param #vec2_table offset
-- @param #size_table originalSize
-- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame)
2014-03-10 14:04:58 +08:00
return nil