2014-03-10 14:04:58 +08:00
--------------------------------
-- @module LayerGradient
2014-03-20 10:21:28 +08:00
-- @extend LayerColor
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
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the start color of the gradient.<br>
-- return The start color.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] getStartColor
-- @param self
2014-05-08 11:19:36 +08:00
-- @return color3b_table#color3b_table ret (return value: color3b_table)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Get the compressedInterpolation<br>
-- return The interpolation will be compressed if true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] isCompressedInterpolation
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the start opacity of the gradient.<br>
-- return The start opacity.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] getStartOpacity
-- @param self
-- @return unsigned char#unsigned char ret (return value: unsigned char)
--------------------------------
2014-09-02 13:45:07 +08:00
-- Sets the directional vector that will be used for the gradient.<br>
2015-03-20 12:53:00 +08:00
-- The default value is vertical direction (0,-1). <br>
-- param alongVector The direction of gradient.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setVector
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #vec2_table alongVector
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the start opacity of the gradient.<br>
-- param startOpacity The start opacity, from 0 to 255.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setStartOpacity
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #unsigned char startOpacity
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Whether or not the interpolation will be compressed in order to display all the colors of the gradient both in canonical and non canonical vectors.<br>
-- Default: true.<br>
-- param compressedInterpolation The interpolation will be compressed if true.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setCompressedInterpolation
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #bool compressedInterpolation
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the end opacity of the gradient.<br>
-- param endOpacity The end opacity, from 0 to 255.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setEndOpacity
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #unsigned char endOpacity
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the directional vector used for the gradient.<br>
-- return The direction of gradient.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] getVector
-- @param self
2014-05-27 14:31:18 +08:00
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Sets the end color of the gradient.<br>
-- param endColor The end color.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setEndColor
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #color3b_table endColor
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
2015-05-05 11:31:53 +08:00
--------------------------------
-- @overload self, color4b_table, color4b_table, vec2_table
-- @overload self, color4b_table, color4b_table
-- @function [parent=#LayerGradient] initWithColor
-- @param self
-- @param #color4b_table start
-- @param #color4b_table end
-- @param #vec2_table v
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the end color of the gradient.<br>
-- return The end color.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] getEndColor
-- @param self
2014-05-08 11:19:36 +08:00
-- @return color3b_table#color3b_table ret (return value: color3b_table)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-20 12:53:00 +08:00
-- Returns the end opacity of the gradient.<br>
-- return The end opacity.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] getEndOpacity
-- @param self
-- @return unsigned char#unsigned char ret (return value: unsigned char)
--------------------------------
2015-03-20 12:53:00 +08:00
-- Sets the start color of the gradient.<br>
-- param startColor The start color.
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] setStartColor
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #color3b_table startColor
2015-01-21 17:33:26 +08:00
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, color4b_table, color4b_table
-- @overload self
-- @overload self, color4b_table, color4b_table, vec2_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#LayerGradient] create
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #color4b_table start
-- @param #color4b_table end
-- @param #vec2_table v
2014-10-17 22:56:22 +08:00
-- @return LayerGradient#LayerGradient ret (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
2015-05-05 11:31:53 +08:00
--------------------------------
--
-- @function [parent=#LayerGradient] init
-- @param self
-- @return bool#bool ret (return value: bool)
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=#LayerGradient] getDescription
-- @param self
-- @return string#string ret (return value: string)
2015-05-05 11:31:53 +08:00
--------------------------------
--
-- @function [parent=#LayerGradient] LayerGradient
-- @param self
-- @return LayerGradient#LayerGradient self (return value: cc.LayerGradient)
2014-03-10 14:04:58 +08:00
return nil