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

History

1726 lines (1725 loc) · 111 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

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

<HTML>

<HEAD>

<!--

p { margin:0; }

-->

</STYLE>

</HEAD>

MAPeD

Data Export Python API v1.8

<HR>

<A HREF="#Graphics Banks Data|region">Graphics

Banks Data</A>

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

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

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

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

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

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

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

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

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

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

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

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

<A HREF="#Layouts Data|region">Layouts

Data</A>

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

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

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

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

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

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

<A HREF="#Entity Instances|region">Entity

Instances</A>

<A HREF="#Entity instance class|region">mpd_inst_entity</A>

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

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

<A HREF="#Base Entities|region">Base

Entities</A>

<A HREF="#Base entity class|region">mpd_base_entity</A>

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

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

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

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

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

<HR>

Graphics

Banks Data

</DIV>

Each graphics bank

contains: CHR bank (1x1),

blocks (2x2), tiles (4x4),

palettes and screens data.

Int32

mpd_num_banks()

</DIV>

Get the number of

graphics banks in a project.

Returns:

the number of graphics

banks in a project

Int32

mpd_get_active_bank()

</DIV>

Get an active graphics

bank index.

Returns:

the index of an active

bank

Int32

mpd_get_tiles_cnt( Int32

_bank_ind )

</DIV>

Get the number of used

tiles (4x4) in a graphics bank.

Parameters:

_bank_ind –

graphics bank index

Returns:

the

number of used tiles or -1

in case of incorrect bank index

Int32

mpd_get_blocks_cnt( Int32

_bank_ind )

</DIV>

Get the number of used

blocks (2x2) in a graphics bank.

Parameters:

_bank_ind –

graphics bank index

Returns:

the

number of used blocks or -1

in case of incorrect bank index

Int32

mpd_get_CHRs_cnt(

Int32 _bank_ind )

</DIV>

Get the number of used

CHRs (1x1) in a graphics bank.

Parameters:

_bank_ind –

graphics bank index

Returns:

the

number of used CHRs or -1

in case of incorrect bank index

Array[UInt64]

mpd_get_tiles( Int32 _bank_ind )

</DIV>

Get an array of 4x4 tiles

in a graphics bank.

Parameters:

_bank_ind –

graphics bank index

Returns:

the 4x4 tiles array or

null in case of incorrect bank index

Each

tile value (UInt64) consists of block's indices

ordered left to right, top to bottom from high to low word

Array[UInt32]

mpd_get_blocks( Int32 _bank_ind )

</DIV>

Get an array of blocks (

2x2 tiles ) in a graphics bank.

Each

block's CHR data (UInt32) has the following bits description:

NES: 15.. [

property_id ](4) [ palette ind ](2) [X](2) [ CHR ind ](8) ..0

SMS: 15.. [

property_id ](4) [ hv_flip ](2) [ palette ind ](1) [CHR ind](9) ..0

PCE: 19.. [

property_id ](4) [ palette ind ](4) [CHR ind](12) ..0

ZX: 15.. [

property_id ](4) [ palette ind ](1) [CHR ind](11) ..0

SMD: 19.. [

property_id ](4) [x](1) [ palette ind ](2) [ hv_flip ](2) [CHR ind](11) ..0

Four UInt32 values form

one 2x2 tile (block).

Parameters:

_bank_ind –

graphics bank index

Returns:

the

blocks data array or null

in case of

incorrect bank index

Array[Byte]

mpd_get_CHRs_data(

Int32 _bank_ind )

</DIV>

Get

a raw CHRs data. The CHR data is stored as

128x128 x number of pages image (8bit).

Parameters:

_bank_ind –

graphics bank index

Returns:

the array of bytes or

null in case of incorrect bank index

Array[Byte]

mpd_get_CHR( Int32

_bank_ind, Int32 _CHR_ind

)

</DIV>

Get

a raw CHR data by index. The data array length is 64 bytes

(8x8 pixels).

Parameters:

_bank_ind –

graphics bank index

_CHR_ind – CHR

index ( min = 0; max = ( mpd_get_CHRs_data( bank_n ).Count / 64 ) - 1

)

Returns:

the array of bytes or

null in case of incorrect bank

index

NES: Long

mpd_export_CHR_data( Int32

_bank_ind, String _filename, Bool

_save_padding )

SMS: Long

mpd_export_CHR_data( Int32

_bank_ind, String _filename, Int32

_bpp )

PCE/ZX/SMD:

Long mpd_export_CHR_data( Int32

_bank_ind, String _filename )

</DIV>

Convert a CHR bank into

platform compatible format and save it to a file.

Parameters:

_bank_ind –

graphics bank 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

Int32

mpd_get_palette_slots( Int32

_bank_ind )

</DIV>

Get the number of palette

slots.

Parameters:

_bank_ind –

graphics bank index

Returns:

the number of palette

slots or -1 in case of incorrect bank index

Array[Int32]

mpd_get_palette( Int32 _bank_ind,

Int32 _plt_ind, Int32

_slot_ind )

</DIV>

Get a 4 colors pallete by

index.

Parameters:

_bank_ind –

graphics bank index

_plt_ind – palette

index (0-3)

_slot_ind – palette

slot index

Returns:

the 4 integers array of

color indices or null in case of incorrect bank index

Int32

mpd_num_screens( Int32

_bank_ind )

</DIV>

Get the number of screens

in a graphics bank.

Parameters:

_bank_ind –

graphics bank index

Returns:

the number of screens

created in a graphics bank or -1 in case of incorrect bank

index

Int32

mpd_screen_mode(

void

)

</DIV>

Get the screen data mode.

Returns:

0 – Tiles4x4; 1 –

Blocks2x2

Array[UInt16]

mpd_get_screen_data( Int32

_bank_ind, Int32 _scr_ind )

</DIV>

Get an array of 4x4 or

2x2 tiles indices which form screen data.

Parameters:

_bank_ind –

graphics bank index

_scr_ind – screen

index

Returns:

the array of 4x4 or 2x2

tiles indices of a particular screen or null in case of

incorrect bank index

<HR>

Layouts Data

</DIV>

Each layout is a matrix

of cells. Each cell can contains a screen index and marks ( adjacent

screens mask + screen property value 0...15 ).

Int32

mpd_num_layouts()

</DIV>

Get the number of layouts

available in a project.

Returns:

the number of layouts

Int32

mpd_layout_width( Int32 _layout_ind

)

</DIV>

Get a layout width.

Parameters:

_layout_ind –

layout index

Returns:

the input layout width or

-1 in case of incorrect layout index

Int32

mpd_layout_height( Int32

_layout_ind )

</DIV>

Get a layout height.

Parameters:

_layout_ind –

layout index

Returns:

the input layout height

or -1 in case of incorrect layout index

Int32

mpd_layout_start_screen_cell(

Int32 _layout_ind )

</DIV>

Get a cell index which

contains a start screen index.

Parameters:

_layout_ind –

layout index

Returns:

the cell index or -1

in case of incorrect layout index

To get a start screen

index you can do the following steps:

layout_width

= mpd_layout_width( layout_n )

layout_height

= mpd_layout_height( layout_n )

start_screen_cell

= mpd_layout_start_screen_cell( layout_n )

start_screen_ind

= mpd_layout_screen_ind( layout_n, start_screen_cell %

layout_width, start_screen_cell / layout_width ) )

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

MAPeD_Data_Export_Python_API.html

Latest commit

History

MAPeD_Data_Export_Python_API.html

File metadata and controls