~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

<indexterm><primary>gimp_pixel_rgn_init</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_init (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

123

124

125

126

127

128

129

130

<para>

131

Initialize the pixel region pointed by <parameter>pr</parameter> with the specified parameters.

132

</para>

133

<para>

134

The <parameter>dirty</parameter> and <parameter>shadow</parameter> flags can be used as follows:

135

</para>

136

<para>

137

- <parameter>dirty</parameter> = FALSE, <parameter>shadow</parameter> = FALSE: the region will be used to read

138

the actual drawable datas. This

139

is useful for save plug-ins or for

140

filters.

141

</para>

142

<para>

143

- <parameter>dirty</parameter> = FALSE, <parameter>shadow</parameter> = TRUE: the region will be used to read the

144

shadow tiles. This is used in

145

some filter plug-ins which operate

146

in two passes such as gaussian

147

blur. The first pass reads the

148

actual drawable data and writes to

149

the shadow tiles, and the second

150

one reads from and writes to the

151

shadow tiles.

152

</para>

153

<para>

154

- <parameter>dirty</parameter> = TRUE, <parameter>shadow</parameter> = TRUE: the region will be used to write to

155

the shadow tiles. It is common

156

practice to write to the shadow

157

tiles and then use

158

#<link linkend="gimp-drawable-merge-shadow"><function>gimp_drawable_merge_shadow()</function></link> to

159

merge the changes from the shadow

160

tiles using the current selection

161

as a mask.

162

</para>

163

<para>

164

- <parameter>dirty</parameter> = TRUE, <parameter>shadow</parameter> = FALSE: the region will be used to directly

165

change the drawable content. Don't

166

do this, since this could prevent

167

the Undo-System from working as

168

expected.</para>

169

<para>

170

171

</para><variablelist role="params">

172

173

<listitem><simpara> a pointer to a <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link> variable.

174

</simpara></listitem></varlistentry>

175

<varlistentry><term><parameter>drawable</parameter> :</term>

176

<listitem><simpara> the <link linkend="GimpDrawable"><type>GimpDrawable</type></link> the new region will be attached to.

177

</simpara></listitem></varlistentry>

178

179

<listitem><simpara> the x coordinate of the top-left pixel of the region in the

180

<parameter>drawable</parameter>.

181

</simpara></listitem></varlistentry>

182

183

<listitem><simpara> the y coordinate of the top-left pixel of the region in the

184

<parameter>drawable</parameter>.

185

</simpara></listitem></varlistentry>

186

<varlistentry><term><parameter>width</parameter> :</term>

187

<listitem><simpara> the width of the region.

188

</simpara></listitem></varlistentry>

189

<varlistentry><term><parameter>height</parameter> :</term>

190

<listitem><simpara> the height of the region.

191

</simpara></listitem></varlistentry>

192

<varlistentry><term><parameter>dirty</parameter> :</term>

193

<listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link> indicating whether the <parameter>drawable</parameter> should be marked

194

as "dirty".

195

</simpara></listitem></varlistentry>

196

<varlistentry><term><parameter>shadow</parameter> :</term>

197

<listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link> indicating whether the region is attached to the

198

shadow tiles or the real <parameter>drawable</parameter> tiles.

199

</simpara></listitem></varlistentry>

200

</variablelist></refsect2>

201

202

<title><anchor id="gimp-pixel-rgn-resize"/>gimp_pixel_rgn_resize ()</title>

203

<indexterm><primary>gimp_pixel_rgn_resize</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_resize (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

204

205

206

207

208

<para>

209

Change the position and size of a previously initialized pixel region.</para>

210

<para>

211

212

</para><variablelist role="params">

213

214

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

215

</simpara></listitem></varlistentry>

216

217

<listitem><simpara> the x coordinate of the new position of the region's

218

top-left corner.

219

</simpara></listitem></varlistentry>

220

221

<listitem><simpara> the y coordinate of the new position of the region's

222

top-left corner.

223

</simpara></listitem></varlistentry>

224

<varlistentry><term><parameter>width</parameter> :</term>

225

<listitem><simpara> the new width of the region.

226

</simpara></listitem></varlistentry>

227

<varlistentry><term><parameter>height</parameter> :</term>

228

<listitem><simpara> the new height of the region.

229

</simpara></listitem></varlistentry>

230

</variablelist></refsect2>

231

232

<title><anchor id="gimp-pixel-rgn-get-pixel"/>gimp_pixel_rgn_get_pixel ()</title>

233

<indexterm><primary>gimp_pixel_rgn_get_pixel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_get_pixel (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

234

235

236

237

<para>

238

Fill the buffer pointed by <parameter>buf</parameter> with the value of the pixel at (<parameter>x</parameter>, <parameter>y</parameter>)

239

in the region <parameter>pr</parameter>. <parameter>buf</parameter> should be large enough to hold the pixel value

240

(1 <link linkend="guchar"><type>guchar</type></link> for an indexed or grayscale drawable, 2 <link linkend="guchar"><type>guchar</type></link> for

241

indexed with alpha or grayscale with alpha drawable, 3 <link linkend="guchar"><type>guchar</type></link> for

242

rgb drawable and 4 <link linkend="guchar"><type>guchar</type></link> for rgb with alpha drawable.</para>

243

<para>

244

245

</para><variablelist role="params">

246

247

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

248

</simpara></listitem></varlistentry>

249

250

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

251

</simpara></listitem></varlistentry>

252

253

<listitem><simpara> the x coordinate of the wanted pixel (relative to the drawable)

254

</simpara></listitem></varlistentry>

255

256

<listitem><simpara> the y coordinate of the wanted pixel (relative to the drawable)

257

</simpara></listitem></varlistentry>

258

</variablelist></refsect2>

259

260

<title><anchor id="gimp-pixel-rgn-get-row"/>gimp_pixel_rgn_get_row ()</title>

261

<indexterm><primary>gimp_pixel_rgn_get_row</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_get_row (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

262

263

264

265

266

<para>

267

Get several pixels of a region in a row. This function fills the buffer

268

<parameter>buf</parameter> with the values of the pixels from (<parameter>x</parameter>, <parameter>y</parameter>) to (<parameter>x</parameter>+<parameter>width</parameter>-1, <parameter>y</parameter>).

269

<parameter>buf</parameter> should be large enough to hold all these values.</para>

270

<para>

271

272

</para><variablelist role="params">

273

274

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

275

</simpara></listitem></varlistentry>

276

277

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

278

</simpara></listitem></varlistentry>

279

280

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

281

</simpara></listitem></varlistentry>

282

283

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

284

</simpara></listitem></varlistentry>

285

<varlistentry><term><parameter>width</parameter> :</term>

286

<listitem><simpara> the number of pixels to get.

287

</simpara></listitem></varlistentry>

288

</variablelist></refsect2>

289

290

<title><anchor id="gimp-pixel-rgn-get-col"/>gimp_pixel_rgn_get_col ()</title>

291

<indexterm><primary>gimp_pixel_rgn_get_col</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_get_col (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

292

293

294

295

296

<para>

297

Get several pixels of a region's column. This function fills the buffer

298

<parameter>buf</parameter> with the values of the pixels from (<parameter>x</parameter>, <parameter>y</parameter>) to (<parameter>x</parameter>, <parameter>y</parameter>+<parameter>height</parameter>-1).

299

<parameter>buf</parameter> should be large enough to hold all these values.</para>

300

<para>

301

302

</para><variablelist role="params">

303

304

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

305

</simpara></listitem></varlistentry>

306

307

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

308

</simpara></listitem></varlistentry>

309

310

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

311

</simpara></listitem></varlistentry>

312

313

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

314

</simpara></listitem></varlistentry>

315

<varlistentry><term><parameter>height</parameter> :</term>

316

<listitem><simpara> the number of pixels to get.

317

</simpara></listitem></varlistentry>

318

</variablelist></refsect2>

319

320

<title><anchor id="gimp-pixel-rgn-get-rect"/>gimp_pixel_rgn_get_rect ()</title>

321

<indexterm><primary>gimp_pixel_rgn_get_rect</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_get_rect (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

322

323

324

325

326

327

<para>

328

Get all the pixel values from the rectangle defined by <parameter>x</parameter>, <parameter>y</parameter>, <parameter>width</parameter> and

329

<parameter>height</parameter>. This function fills the buffer <parameter>buf</parameter> with the values of the pixels

330

from (<parameter>x</parameter>, <parameter>y</parameter>) to (<parameter>x</parameter>+<parameter>width</parameter>-1, <parameter>y</parameter>+<parameter>height</parameter>-1).

331

<parameter>buf</parameter> should be large enough to hold all these values (<parameter>width</parameter>*<parameter>height</parameter>*bpp).</para>

332

<para>

333

334

</para><variablelist role="params">

335

336

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

337

</simpara></listitem></varlistentry>

338

339

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

340

</simpara></listitem></varlistentry>

341

342

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

343

</simpara></listitem></varlistentry>

344

345

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

346

</simpara></listitem></varlistentry>

347

<varlistentry><term><parameter>width</parameter> :</term>

348

<listitem><simpara> the width of the rectangle.

349

</simpara></listitem></varlistentry>

350

<varlistentry><term><parameter>height</parameter> :</term>

351

<listitem><simpara> the height of the rectangle.

352

</simpara></listitem></varlistentry>

353

</variablelist></refsect2>

354

355

<title><anchor id="gimp-pixel-rgn-set-pixel"/>gimp_pixel_rgn_set_pixel ()</title>

356

<indexterm><primary>gimp_pixel_rgn_set_pixel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_set_pixel (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

357

const <link linkend="guchar">guchar</link> *buf,

358

359

360

<para>

361

Set the pixel at (<parameter>x</parameter>, <parameter>y</parameter>) to the values from <parameter>buf</parameter>.</para>

362

<para>

363

364

</para><variablelist role="params">

365

366

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

367

</simpara></listitem></varlistentry>

368

369

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>.

370

</simpara></listitem></varlistentry>

371

372

<listitem><simpara> the x coordinate of the pixel (relative to the drawable).

373

</simpara></listitem></varlistentry>

374

375

<listitem><simpara> the y coordinate of the pixel (relative to the drawable).

376

</simpara></listitem></varlistentry>

377

</variablelist></refsect2>

378

379

<title><anchor id="gimp-pixel-rgn-set-row"/>gimp_pixel_rgn_set_row ()</title>

380

<indexterm><primary>gimp_pixel_rgn_set_row</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_set_row (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

381

const <link linkend="guchar">guchar</link> *buf,

382

383

384

385

<para>

386

Set several pixels of a region in a row. This function draws the pixels

387

from (<parameter>x</parameter>, <parameter>y</parameter>) to (<parameter>x</parameter>+<parameter>width</parameter>-1, <parameter>y</parameter>) using the values of the buffer <parameter>buf</parameter>.

388

<parameter>buf</parameter> should be large enough to hold all these values.</para>

389

<para>

390

391

</para><variablelist role="params">

392

393

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

394

</simpara></listitem></varlistentry>

395

396

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

397

</simpara></listitem></varlistentry>

398

399

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

400

</simpara></listitem></varlistentry>

401

402

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

403

</simpara></listitem></varlistentry>

404

<varlistentry><term><parameter>width</parameter> :</term>

405

<listitem><simpara> the number of pixels to set.

406

</simpara></listitem></varlistentry>

407

</variablelist></refsect2>

408

409

<title><anchor id="gimp-pixel-rgn-set-col"/>gimp_pixel_rgn_set_col ()</title>

410

<indexterm><primary>gimp_pixel_rgn_set_col</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_set_col (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

411

const <link linkend="guchar">guchar</link> *buf,

412

413

414

415

<para>

416

Set several pixels of a region's column. This function draws the pixels

417

from (<parameter>x</parameter>, <parameter>y</parameter>) to (<parameter>x</parameter>, <parameter>y</parameter>+<parameter>height</parameter>-1) using the values from the buffer <parameter>buf</parameter>.

418

<parameter>buf</parameter> should be large enough to hold all these values.</para>

419

<para>

420

421

</para><variablelist role="params">

422

423

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

424

</simpara></listitem></varlistentry>

425

426

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

427

</simpara></listitem></varlistentry>

428

429

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

430

</simpara></listitem></varlistentry>

431

432

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

433

</simpara></listitem></varlistentry>

434

<varlistentry><term><parameter>height</parameter> :</term>

435

<listitem><simpara> the number of pixels to set.

436

</simpara></listitem></varlistentry>

437

</variablelist></refsect2>

438

439

<title><anchor id="gimp-pixel-rgn-set-rect"/>gimp_pixel_rgn_set_rect ()</title>

440

<indexterm><primary>gimp_pixel_rgn_set_rect</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixel_rgn_set_rect (<link linkend="GimpPixelRgn">GimpPixelRgn</link> *pr,

441

const <link linkend="guchar">guchar</link> *buf,

442

443

444

445

446

<para>

447

Set all the pixel of the rectangle defined by <parameter>x</parameter>, <parameter>y</parameter>, <parameter>width</parameter> and

448

<parameter>height</parameter>. This function draws the rectangle from (<parameter>x</parameter>, <parameter>y</parameter>) to

449

(<parameter>x</parameter>+<parameter>width</parameter>-1, <parameter>y</parameter>+<parameter>height</parameter>-1), using the pixel values from the buffer <parameter>buf</parameter>.

450

<parameter>buf</parameter> should be large enough to hold all these values (<parameter>width</parameter>*<parameter>height</parameter>*bpp).</para>

451

<para>

452

453

</para><variablelist role="params">

454

455

<listitem><simpara> a pointer to a previously initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

456

</simpara></listitem></varlistentry>

457

458

<listitem><simpara> a pointer to an array of <link linkend="guchar"><type>guchar</type></link>

459

</simpara></listitem></varlistentry>

460

461

<listitem><simpara> the x coordinate of the first pixel (relative to the drawable).

462

</simpara></listitem></varlistentry>

463

464

<listitem><simpara> the y coordinate of the first pixel (relative to the drawable).

465

</simpara></listitem></varlistentry>

466

<varlistentry><term><parameter>width</parameter> :</term>

467

<listitem><simpara> the width of the rectangle.

468

</simpara></listitem></varlistentry>

469

<varlistentry><term><parameter>height</parameter> :</term>

470

<listitem><simpara> the height of the rectangle.

471

</simpara></listitem></varlistentry>

472

</variablelist></refsect2>

473

474

<title><anchor id="gimp-pixel-rgns-register"/>gimp_pixel_rgns_register ()</title>

475

<indexterm><primary>gimp_pixel_rgns_register</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> gimp_pixel_rgns_register (<link linkend="gint">gint</link> nrgns,

476

...);</programlisting>

477

<para>

478

This is the varargs version of <link linkend="gimp-pixel-rgns-register2"><type>gimp_pixel_rgns_register2</type></link>.</para>

479

<para>

480

481

</para><variablelist role="params">

482

<varlistentry><term><parameter>nrgns</parameter> :</term>

483

<listitem><simpara> the number of regions to register.

484

</simpara></listitem></varlistentry>

485

486

<listitem><simpara> <parameter>nrgns</parameter> pointers to <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

487

</simpara></listitem></varlistentry>

488

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> to a regions iterator.

489

</simpara></listitem></varlistentry>

490

</variablelist></refsect2>

491

492

<title><anchor id="gimp-pixel-rgns-register2"/>gimp_pixel_rgns_register2 ()</title>

493

<indexterm><primary>gimp_pixel_rgns_register2</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> gimp_pixel_rgns_register2 (<link linkend="gint">gint</link> nrgns,

494

495

<para>

496

It takes a number of initialized regions of the same size and provides a

497

pixel region iterator the iterator can be used to iterate over the

498

registered pixel regions. While iterating the registered pixel regions will

499

cover subsets of the original pixel regions, chosen for optimized access to

500

the image data.

501

</para>

502

<para>

503

Note that the given regions themselves are changed by this function, so

504

they are resized to the first subsets.

505

</para>

506

<para>

507

This function has to be used together with gimp_pixel_rgns_process in a loop.</para>

508

<para>

509

510

</para><variablelist role="params">

511

<varlistentry><term><parameter>nrgns</parameter> :</term>

512

<listitem><simpara> the number of regions to register.

513

</simpara></listitem></varlistentry>

514

515

<listitem><simpara> an array of <parameter>nrgns</parameter> pointers to initialized <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>.

516

</simpara></listitem></varlistentry>

517

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> to a regions iterator.

518

</simpara></listitem></varlistentry>

519

</variablelist></refsect2>

520

521

<title><anchor id="gimp-pixel-rgns-process"/>gimp_pixel_rgns_process ()</title>

522

<indexterm><primary>gimp_pixel_rgns_process</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> gimp_pixel_rgns_process (<link linkend="gpointer">gpointer</link> pri_ptr);</programlisting>

523

<para>

524

This function update the regions registered previously with one of the

525

526

<para>

527

528

</para><variablelist role="params">

529

530

<listitem><simpara> a regions iterator returned by <link linkend="gimp-pixel-rgns-register"><type>gimp_pixel_rgns_register</type></link>,

531

532

</simpara></listitem></varlistentry>

533

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> to a new regions iterator or <link linkend="NULL:CAPS"><type>NULL</type></link> if there isn't

534

any tiles left.

535

</simpara></listitem></varlistentry>

536

</variablelist></refsect2>

537

538

</refsect1>

539

540

541

542

543

</refentry>

Older »