MAPeD-SPReD/doc/SPReD_Data_Export_Python_API.html at master · 0x8BitDev/MAPeD-SPReD

History

565 lines (565 loc) · 36.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<HTML>

<HEAD>

<!--

p { margin:0; }

-->

</STYLE>

</HEAD>

SPReD

Data Export Python API v1.2

<HR>

<A HREF="#Main Functions|region">Main

Functions</A>

<A HREF="#spd_8x16_mode_enabled|region">spd_8x16_mode_enabled</A>

<A HREF="#spd_get_palette|region">spd_get_palette</A>

<A HREF="#spd_num_sprites|region">spd_num_sprites</A>

<A HREF="#spd_get_sprite_data|region">spd_get_sprite_data</A>

<A HREF="#spd_export_CHR_data|region">spd_export_CHR_data</A>

<A HREF="#Sprite Data Structures|region">Sprite

Data Structures</A>

<A HREF="#Sprite data class|region">spd_sprite_data</A>

<A HREF="#Sprite attribute class|region">spd_sprite_attr</A>

<A HREF="#Miscellaneous|region">Miscellaneous</A>

<HR>

Main Functions

</DIV>

Bool

spd_8x16_mode_enabled()

</DIV>

Retrieve the 8x16 mode status.

Returns:

True – enabled; False –

disabled

Array[Int32]

spd_get_palette(

Int32 _plt_ind )

</DIV>

Get NES/SMS: 4-colors, PCE: 16-colors palette by index.

Parameters:

_plt_ind – palette

index NES/SMS: 0-3; PCE: 0-15

Returns:

the array of color

indices or null in case of incorrect palette index

Int32 spd_num_sprites()

</DIV>

Get the number of sprites

in a project.

Returns:

the number of sprites in

a project

<A HREF="#Sprite data class|region">spd_sprite_data</A>

spd_get_sprite_data(

Int32

_spr_ind

)

</DIV>

Get a sprite data by

index.

Parameters:

_spr_ind – sprite

index

Returns:

the

<A HREF="#Sprite data class|region">spd_sprite_data</A> object or

null

in

case of an error

NES: Long

spd_export_CHR_data( Int32

_spr_ind, String

_filename, Bool _save_padding )

SMS: Long

spd_export_CHR_data( Int32

_spr_ind, String

_filename, Int32 _bpp )

PCE: Long

spd_export_CHR_data( Int32

_spr_ind, String

_filename )

</DIV>

Convert a sprite's CHR

bank into a NES/SMS/PCE compatible format and save it to a file.

Parameters:

_spr_ind – sprite

index

_filename –

exported data filename

_save_padding –

save padding data aligned to 1/2/4 KB or not

_bpp –

bits per pixel value ( the valid range is 1-4 )

Returns:

the size of a saved file in

bytes or -1 in case of an error

<HR>

Sprite Data

Structures

</DIV>

Sprite data class:

</DIV>

class spd_sprite_data

{

// string name

public String name;

// offset from origin

public Int32 offset_x;

public Int32 offset_y;

// sprite dimensions in pixels

public Int32 width;

public Int32 height;

// attributes array ( can be None )

public

<A HREF="#Sprite attribute class|region">spd_sprite_attr</A>[] attrs;

// 1x1 tiles array ( can be None )

public <A HREF="#Sprite CHR data class|region">spd_CHR_bank</A>

CHR_bank;

}

Sprite attribute class:

</DIV>

class spd_sprite_attr

{

// CHR

coordinates

public Int32

x;

public Int32

y;

// palette index

0-3

// SMS:

ignored

public Int32

palette_ind;

// CHR index

public Int32

CHR_ind;

// horizontal

flip = 0x01

// vertical flip

= 0x02

// SMS:

ignored

public Int32

flip_flag;

}

CHR bank class:

</DIV>

class spd_CHR_bank

{

// unique id

public Int32

id;

// the number of

sprites that share a CHR bank

public Int32

link_cnt;

// array of 1x1

tiles

public <A HREF="#CHR data class|region">spd_CHR_data</A>[]

CHR_data;

}

CHR data class:

</DIV>

class spd_CHR_data

{

// 8x8 bytes

array

// NES: 0-3 color indices

// SMS: 0-15 color indices

public Byte[]

data;

}

<HR>

Miscellaneous

</DIV>

void spd_msg_box(

String _msg, String _caption )

</DIV>

Show message box.

Parameters:

_msg – message text

_caption – caption

text

<HR>

Copyright

</BODY>

</HTML>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

SPReD_Data_Export_Python_API.html

Latest commit

History

SPReD_Data_Export_Python_API.html

File metadata and controls