2014-03-10 14:04:58 +08:00
--------------------------------
-- @module RenderTexture
2014-03-20 10:21:28 +08:00
-- @extend Node
2014-06-25 17:36:50 +08:00
-- @parent_module cc
2014-03-18 15:55:30 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Used for grab part of screen to a texture.rtBegin: the position of renderTexture on the fullRectfullRect: the total size of screenfullViewport: the total viewportSize
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setVirtualViewport
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #vec2_table rtBegin
-- @param #rect_table fullRect
-- @param #rect_table fullViewport
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- clears the texture with a specified stencil value
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] clearStencil
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #int stencilValue
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Value for clearDepth. Valid only when "autoDraw" is true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] getClearDepth
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
2014-09-02 13:45:07 +08:00
-- Value for clear Stencil. Valid only when "autoDraw" is true
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] getClearStencil
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
2014-09-02 13:45:07 +08:00
-- ends grabbing
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] end
-- @param self
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setClearStencil
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #int clearStencil
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Sets the Sprite being used.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setSprite
-- @param self
-- @param #cc.Sprite sprite
--------------------------------
2014-09-02 13:45:07 +08:00
-- Gets the Sprite being used.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] getSprite
-- @param self
-- @return Sprite#Sprite ret (return value: cc.Sprite)
--------------------------------
2014-09-02 13:45:07 +08:00
-- When enabled, it will render its children into the texture automatically. Disabled by default for compatiblity reasons.<br>
-- Will be enabled in the future.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] isAutoDraw
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setKeepMatrix
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #bool keepMatrix
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setClearFlags
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #unsigned int clearFlags
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- starts grabbing
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] begin
-- @param self
--------------------------------
2014-08-13 14:42:14 +08:00
-- @overload self, string, int, bool, function
-- @overload self, string, bool, function
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] saveToFile
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #string filename
2014-07-17 22:20:04 +08:00
-- @param #int format
2014-09-02 13:45:07 +08:00
-- @param #bool isRGBA
-- @param #function callback
2014-03-10 14:04:58 +08:00
-- @return bool#bool ret (retunr value: bool)
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setAutoDraw
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #bool isAutoDraw
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setClearColor
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #color4f_table clearColor
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- end is key word of lua, use other name to export to lua.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] endToLua
-- @param self
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, float, float, float, float, float
-- @overload self, float, float, float, float
-- @overload self, float, float, float, float, float, int
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] beginWithClear
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float r
-- @param #float g
-- @param #float b
-- @param #float a
-- @param #float depthValue
-- @param #int stencilValue
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- clears the texture with a specified depth value
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] clearDepth
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float depthValue
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Clear color value. Valid only when "autoDraw" is true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] getClearColor
-- @param self
2014-05-08 11:19:36 +08:00
-- @return color4f_table#color4f_table ret (return value: color4f_table)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- clears the texture with a color
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] clear
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float r
-- @param #float g
-- @param #float b
-- @param #float a
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Valid flags: GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, GL_STENCIL_BUFFER_BIT. They can be OR'ed. Valid when "autoDraw" is true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] getClearFlags
-- @param self
-- @return unsigned int#unsigned int ret (return value: unsigned int)
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] newImage
-- @param self
-- @return Image#Image ret (return value: cc.Image)
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] setClearDepth
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float clearDepth
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 22:20:04 +08:00
-- @overload self, int, int, int, unsigned int
-- @overload self, int, int, int
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] initWithWidthAndHeight
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #int w
-- @param #int h
-- @param #int format
-- @param #unsigned int depthStencilFormat
2014-03-10 14:04:58 +08:00
-- @return bool#bool ret (retunr value: bool)
--------------------------------
2014-07-17 22:20:04 +08:00
-- @overload self, int, int, int
-- @overload self, int, int, int, unsigned int
2014-07-17 10:28:34 +08:00
-- @overload self, int, int
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] create
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #int w
-- @param #int h
-- @param #int format
-- @param #unsigned int depthStencilFormat
2014-03-10 14:04:58 +08:00
-- @return RenderTexture#RenderTexture ret (retunr value: cc.RenderTexture)
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-18 15:55:30 +08:00
-- @function [parent=#RenderTexture] draw
-- @param self
-- @param #cc.Renderer renderer
2014-09-02 13:45:07 +08:00
-- @param #mat4_table transform
-- @param #unsigned int flags
2014-03-18 15:55:30 +08:00
2014-05-23 11:12:39 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-05-23 11:12:39 +08:00
-- @function [parent=#RenderTexture] visit
-- @param self
-- @param #cc.Renderer renderer
2014-09-02 13:45:07 +08:00
-- @param #mat4_table parentTransform
-- @param #unsigned int parentFlags
2014-05-23 11:12:39 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#RenderTexture] RenderTexture
-- @param self
return nil