1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gsk.RadialGradientNode; 26 27 private import glib.ConstructionException; 28 private import gobject.ObjectG; 29 private import graphene.Point; 30 private import graphene.Rect; 31 private import gsk.RenderNode; 32 private import gsk.c.functions; 33 public import gsk.c.types; 34 35 36 /** 37 * A render node for a radial gradient. 38 */ 39 public class RadialGradientNode : RenderNode 40 { 41 /** the main Gtk struct */ 42 protected GskRadialGradientNode* gskRadialGradientNode; 43 44 /** Get the main Gtk struct */ 45 public GskRadialGradientNode* getRadialGradientNodeStruct(bool transferOwnership = false) 46 { 47 if (transferOwnership) 48 ownedRef = false; 49 return gskRadialGradientNode; 50 } 51 52 /** the main Gtk struct as a void* */ 53 protected override void* getStruct() 54 { 55 return cast(void*)gskRadialGradientNode; 56 } 57 58 /** 59 * Sets our main struct and passes it to the parent class. 60 */ 61 public this (GskRadialGradientNode* gskRadialGradientNode, bool ownedRef = false) 62 { 63 this.gskRadialGradientNode = gskRadialGradientNode; 64 super(cast(GskRenderNode*)gskRadialGradientNode, ownedRef); 65 } 66 67 68 /** */ 69 public static GType getType() 70 { 71 return gsk_radial_gradient_node_get_type(); 72 } 73 74 /** 75 * Creates a `GskRenderNode` that draws a radial gradient. 76 * 77 * The radial gradient 78 * starts around @center. The size of the gradient is dictated by @hradius 79 * in horizontal orientation and by @vradius in vertial orientation. 80 * 81 * Params: 82 * bounds = the bounds of the node 83 * center = the center of the gradient 84 * hradius = the horizontal radius 85 * vradius = the vertical radius 86 * start = a percentage >= 0 that defines the start of the gradient around @center 87 * end = a percentage >= 0 that defines the end of the gradient around @center 88 * colorStops = a pointer to an array of 89 * `GskColorStop` defining the gradient. The offsets of all color stops 90 * must be increasing. The first stop's offset must be >= 0 and the last 91 * stop's offset must be <= 1. 92 * 93 * Returns: A new `GskRenderNode` 94 * 95 * Throws: ConstructionException GTK+ fails to create the object. 96 */ 97 public this(Rect bounds, Point center, float hradius, float vradius, float start, float end, GskColorStop[] colorStops) 98 { 99 auto __p = gsk_radial_gradient_node_new((bounds is null) ? null : bounds.getRectStruct(), (center is null) ? null : center.getPointStruct(), hradius, vradius, start, end, colorStops.ptr, cast(size_t)colorStops.length); 100 101 if(__p is null) 102 { 103 throw new ConstructionException("null returned by new"); 104 } 105 106 this(cast(GskRadialGradientNode*) __p); 107 } 108 109 /** 110 * Retrieves the center pointer for the gradient. 111 * 112 * Returns: the center point for the gradient 113 */ 114 public Point getCenter() 115 { 116 auto __p = gsk_radial_gradient_node_get_center(cast(GskRenderNode*)gskRadialGradientNode); 117 118 if(__p is null) 119 { 120 return null; 121 } 122 123 return ObjectG.getDObject!(Point)(cast(graphene_point_t*) __p); 124 } 125 126 /** 127 * Retrieves the color stops in the gradient. 128 * 129 * Returns: the color stops in the gradient 130 */ 131 public GskColorStop[] getColorStops() 132 { 133 size_t nStops; 134 135 auto __p = gsk_radial_gradient_node_get_color_stops(cast(GskRenderNode*)gskRadialGradientNode, &nStops); 136 137 return __p[0 .. nStops]; 138 } 139 140 /** 141 * Retrieves the end value for the gradient. 142 * 143 * Returns: the end value for the gradient 144 */ 145 public float getEnd() 146 { 147 return gsk_radial_gradient_node_get_end(cast(GskRenderNode*)gskRadialGradientNode); 148 } 149 150 /** 151 * Retrieves the horizonal radius for the gradient. 152 * 153 * Returns: the horizontal radius for the gradient 154 */ 155 public float getHradius() 156 { 157 return gsk_radial_gradient_node_get_hradius(cast(GskRenderNode*)gskRadialGradientNode); 158 } 159 160 /** 161 * Retrieves the number of color stops in the gradient. 162 * 163 * Returns: the number of color stops 164 */ 165 public size_t getNColorStops() 166 { 167 return gsk_radial_gradient_node_get_n_color_stops(cast(GskRenderNode*)gskRadialGradientNode); 168 } 169 170 /** 171 * Retrieves the start value for the gradient. 172 * 173 * Returns: the start value for the gradient 174 */ 175 public float getStart() 176 { 177 return gsk_radial_gradient_node_get_start(cast(GskRenderNode*)gskRadialGradientNode); 178 } 179 180 /** 181 * Retrieves the vertical radius for the gradient. 182 * 183 * Returns: the vertical radius for the gradient 184 */ 185 public float getVradius() 186 { 187 return gsk_radial_gradient_node_get_vradius(cast(GskRenderNode*)gskRadialGradientNode); 188 } 189 }