CesiumGS / CesiumGS/cesium

Move classes from the Public API out of Renderer

Open
#9,750 0 comments 0 reactions 0 assignees View on GitHub
category - architecture / api type - enhancement
Dominant language
JavaScript
Stars
15.7k
Forks
3.9k
Avg merge
4d 6h
Merged PRs (30d)
34

Description

Today I noticed that `PixelDataType` is [part of the public API](https://cesium.com/learn/cesiumjs/ref-doc/global.html?classFilter=pixeldat#PixelDatatype), even though the file is in `Source/Renderer`.

Talking with @lilleyse, this is incorrect. `Renderer` is for private API classes/enums only. If there are files there that are part of the public API, they should be moved to `Core`.

It would be good to do a thorough sweep through `Renderer`, so far I've only encountered these classes/enums out of place:
* `PixelDataType`
* `TextureMagnificationFilter`
* `TextureMinificationFilter`

Contributor guide

Open the contributing guide

Research direction

Start by surveying the public API classes and enums under Source/Renderer, using PixelDataType, TextureMagnificationFilter, and TextureMinificationFilter as the initial candidates. Compare their public API documentation with the Renderer/Core organization, then move every confirmed public API item to Core and verify that the documented names and references still resolve.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
computer-graphics
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.