Skip to content

docs: fix README and ROADMAP for struct-based UpdateRegion API #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kolkov merged 1 commit into from
Aug 30, 2026
Merged

docs: fix README and ROADMAP for struct-based UpdateRegion API #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.31.2] - 2026-08-30

### Fixed

- **docs:** update README and ROADMAP for struct-based `UpdateRegion` API (`image.Rectangle` + `ImageDataLayout`). v0.31.1 shipped with stale documentation showing old 6-parameter signature.

## [0.31.1] - 2026-08-30

### Changed
Expand Down
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,17 @@ type TextureUpdater interface {
UpdateData(data []byte) error
}

// ImageDataLayout describes the memory layout of pixel data for region uploads.
// Mirrors W3C GPUTexelCopyBufferLayout at the application level.
type ImageDataLayout struct {
BytesPerRow int // 0 = tight packed (w * bytesPerPixel)
RowsPerImage int // 0 = height (for 3D/array textures)
Offset int // byte offset into data
}

// TextureRegionUpdater uploads only a sub-rectangle (partial upload)
type TextureRegionUpdater interface {
UpdateRegion(x, y, w, h int, data []byte) error
UpdateRegion(region image.Rectangle, data []byte, layout ImageDataLayout) error
}
```

Expand Down
10 changes: 8 additions & 2 deletions ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

`gpucontext` is the shared foundation for the [gogpu](https://github.com/gogpu) ecosystem, providing interfaces and utilities for GPU resource sharing without circular dependencies.

## Current: v0.31.0
## Current: v0.31.2

- `TextureRegionUpdater.UpdateRegion` strided upload (`bytesPerRow`, #484)
- `TextureRegionUpdater.UpdateRegion` struct API (`image.Rectangle` + `ImageDataLayout`, #484)
- `DeviceProvider.DownlevelCapabilities()` (ADR-071)
- `DeviceProvider.Features()` — query device capabilities (FeatureRayQuery, etc.)
- SurfaceCompositor interface (ADR-067)
Expand All @@ -21,6 +21,12 @@

## Released

### v0.31.2 (2026-08-30)
- docs: fix README and ROADMAP for struct-based UpdateRegion API

### v0.31.1 (2026-08-30)
- `TextureRegionUpdater.UpdateRegion` — struct API: `image.Rectangle` + `ImageDataLayout` (#484)

### v0.31.0 (2026-08-30)
- `TextureRegionUpdater.UpdateRegion` — `bytesPerRow` parameter (pre-v1.0, #484)

Expand Down
Loading