@zephyr3d/device 0.2.8 → 0.2.10

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Nullable, Immutable, TypedArray, IDisposable, CubeFace, VectorBase, MaybeArray, IEventTarget, Vector4, Observable } from '@zephyr3d/base';
+import { Nullable, Immutable, TypedArray, IDisposable, CubeFace, VectorBase, MaybeArray, IEventTarget, Vector3, Vector4, Rect, Observable } from '@zephyr3d/base';
 
 /**
  * Struct layout types
@@ -1572,7 +1572,7 @@ interface ProgramBuilder {
      * @param options - The build options
      * @returns a tuple made by vertex shader source, fragment shader source, bind group layouts and vertex attributes used, or null if build faild
      */
-    buildRender(options: PBRenderOptions): readonly [string, string, BindGroupLayout[], number[]];
+    buildRender(options: PBRenderOptions): readonly [string, string, BindGroupLayout[], number[], number];
     /**
      * Generates shader code for a compute program
      * @param options - The build programs
@@ -3290,6 +3290,8 @@ interface RenderProgramConstructParams {
     vs: string;
     /** The fragment shader source code */
     fs: string;
+    /** Number of fragment color outputs declared by the shader */
+    fragmentOutputCount?: number;
     /** Bind group layouts for the program */
     bindGroupLayouts: BindGroupLayout[];
     /** Vertex attributes used in the program */
@@ -3359,6 +3361,28 @@ type DeviceViewport = {
      */
     default: boolean;
 };
+/**
+ * Horizontal alignment for text layout
+ * @public
+ */
+type TextHorizontalAlignment = 'left' | 'center' | 'right';
+/**
+ * Vertical alignment for text layout
+ * @public
+ */
+type TextVerticalAlignment = 'top' | 'center' | 'bottom';
+/**
+ * Layout options for drawing text inside a rectangle
+ * @public
+ */
+interface DrawTextLayoutOptions {
+    /** Horizontal alignment of each line */
+    halign?: TextHorizontalAlignment;
+    /** Vertical alignment of the text block */
+    valign?: TextVerticalAlignment;
+    /** Whether to wrap text automatically to fit the rectangle width */
+    wordWrap?: boolean;
+}
 /**
  * Abstract interface for the rendering device.
  * @public
@@ -3397,7 +3421,9 @@ interface AbstractDevice extends IEventTarget<DeviceEventMap> {
     /** Cancel schedule next frame */
     cancelNextFrame(handle: number): void;
     /** Set font for drawText function */
-    setFont(fontName: string): void;
+    setFont(fontName: Nullable<string>): void;
+    /** Set render states to be used when drawing text. If not set, default states will be used. */
+    setTextRenderStates(states: Nullable<RenderStateSet>): void;
     /**
      * Draw a string
      * @param text - The string that will be drawn
@@ -3405,7 +3431,15 @@ interface AbstractDevice extends IEventTarget<DeviceEventMap> {
      * @param y - y coordinate in pixels related to the viewport origin
      * @param color - A CSS color value
      */
-    drawText(text: string, x: number, y: number, color: string, viewport?: Immutable<number[]>): void;
+    drawText(text: string, x: number, y: number, color: string | Vector3 | Vector4): void;
+    /**
+     * Draw a string inside a rectangle with layout and clipping
+     * @param text - The string that will be drawn
+     * @param rect - Layout rectangle in pixels related to the viewport origin
+     * @param color - A CSS color value
+     * @param options - Text layout options
+     */
+    drawText(text: string, rect: Immutable<Rect>, color: string | Vector3 | Vector4, options?: DrawTextLayoutOptions): void;
     /**
      * Clears the current frame buffer
      * @param clearColor - If not null, the color buffer will be cleared to this value.
@@ -3986,8 +4020,10 @@ declare abstract class BaseDevice extends Observable<DeviceEventMap> {
     get programBuilder(): ProgramBuilder;
     poolExists(key: string | symbol): boolean;
     getPool(key: string | symbol): Pool;
-    setFont(fontName: string): void;
-    drawText(text: string, x: number, y: number, color: string, viewport?: Immutable<number[]>): void;
+    setFont(fontName: Nullable<string>): void;
+    setTextRenderStates(renderStates: Nullable<RenderStateSet>): void;
+    drawText(text: string, x: number, y: number, color: string | Vector3 | Vector4): void;
+    drawText(text: string, rect: Immutable<Rect>, color: string | Vector3 | Vector4, options?: DrawTextLayoutOptions): void;
     setFramebuffer(rt: Nullable<FrameBuffer>): void;
     setFramebuffer(color: BaseTexture[], depth?: BaseTexture, sampleCount?: number): void;
     disposeObject(obj: GPUObject, remove?: boolean): void;
@@ -4078,6 +4114,18 @@ declare class TextureAtlasManager {
      * @returns Atlas texture for given index
      */
     getAtlasTexture(index: number): Texture2D<unknown> | undefined;
+    /**
+     * Width of each atlas bin in texels.
+     */
+    get binWidth(): number;
+    /**
+     * Height of each atlas bin in texels.
+     */
+    get binHeight(): number;
+    /**
+     * Border reserved around each packed rectangle in texels.
+     */
+    get rectBorderWidth(): number;
     /**
      * Gets the information about specified atlas
      * @param key - Key of the atlas
@@ -4214,7 +4262,12 @@ declare class DrawText {
      * @param device - The render device
      * @param name - The font name
      */
-    static setFont(device: AbstractDevice, name: string): void;
+    static setFont(device: AbstractDevice, name: Nullable<string>): void;
+    /**
+     * Set render states to be used when drawing text. If not set, default states will be used.
+     * @param renderStates - The render states to use when drawing text. If null, default states will be used.
+     */
+    static setRenderStates(renderStates: Nullable<RenderStateSet>): void;
     /**
      * Draw text onto the screen
      * @param device - The render device
@@ -4223,7 +4276,16 @@ declare class DrawText {
      * @param x - X coordinate of the text
      * @param y - Y coordinate of the text
      */
-    static drawText(device: AbstractDevice, text: string, color: string, x: number, y: number, viewport?: Immutable<number[]>): void;
+    static drawText(device: AbstractDevice, text: string, color: string | Vector3 | Vector4, x: number, y: number): void;
+    /**
+     * Draw text inside a rectangle with layout and clipping
+     * @param device - The render device
+     * @param text - The text to be drawn
+     * @param color - The text color
+     * @param rect - The layout rectangle
+     * @param options - Layout options
+     */
+    static drawText(device: AbstractDevice, text: string, color: string | Vector3 | Vector4, rect: Immutable<Rect>, options?: DrawTextLayoutOptions): void;
 }
 
 /**
@@ -4251,4 +4313,4 @@ declare class StructuredBufferData {
     set(name: string, value: StructuredValue): void;
 }
 
-export { type AbstractDevice, type ArrayTypeDetail, type AtlasInfo, type AtomicTypeInfoDetail, type BaseCreationOptions, BaseDevice, type BaseTexture, type BindGroup, type BindGroupLayout, type BindGroupLayoutEntry, type BindPointInfo, type BlendEquation, type BlendFunc, type BlendingState, type BufferBindingLayout, type BufferCreationOptions, type BufferUsage, CPUTimer, type ColorState, type CompareFunc, type ComputeProgramConstructParams, type DataType, type DepthState, type DeviceBackend, type DeviceCaps, type DeviceEventMap, type DeviceOptions, type DeviceViewport, DrawText, type ExpValueNonArrayType, type ExpValueType, type ExternalTextureBindingLayout, type FaceMode, type FaceWinding, Font, type FrameBuffer, type FrameBufferOptions, type FrameBufferTextureAttachment, type FrameInfo, type FramebufferCaps, type FunctionTypeDetail, type GPUDataBuffer, type GPUObject, type GPUObjectList, type GPUProgram, type GPUProgramConstructParams, GPUResourceUsageFlags, GlyphManager, type ITimer, type IndexBuffer, MAX_BINDING_GROUPS, MAX_TEXCOORD_INDEX_COUNT, MAX_VERTEX_ATTRIBUTES, type MiscCaps, PBAddressSpace, PBAnyTypeInfo, PBArrayTypeInfo, PBAtomicI32TypeInfo, PBAtomicU32TypeInfo, PBBuiltinScope, type PBComputeOptions, PBDoWhileScope, PBForScope, PBFunctionScope, PBFunctionTypeInfo, PBGlobalScope, PBIfScope, PBInputScope, PBInsideFunctionScope, PBLocalScope, PBNakedScope, PBOutputScope, PBPointerTypeInfo, PBPrimitiveType, PBPrimitiveTypeInfo, PBReflection, type PBReflectionTagGetter, type PBRenderOptions, PBSamplerAccessMode, PBSamplerTypeInfo, PBScope, PBShaderExp, type PBStructLayout, PBStructTypeInfo, PBTextureType, PBTextureTypeInfo, PBTypeInfo, PBVoidTypeInfo, PBWhileScope, type PointerTypeDetail, Pool, type PrimitiveType, type PrimitiveTypeDetail, ProgramBuilder, Proxiable, type RasterizerState, type RenderBundle, type RenderProgramConstructParams, type RenderStateSet, type SamplerBindingLayout, type SamplerOptions, type SamplerTypeDetail, type ShaderCaps, type ShaderExpTagRecord, type ShaderExpTagValue, type ShaderKind, ShaderType, type ShaderTypeFunc, type StencilOp, type StencilState, type StorageTextureBindingLayout, type StructTypeDetail, type StructuredBuffer, StructuredBufferData, type StructuredValue, type Texture2D, type Texture2DArray, type Texture3D, type TextureAddressMode, TextureAtlasManager, type TextureBindingLayout, type TextureCaps, type TextureColorSpace, type TextureCreationOptions, type TextureCube, type TextureFilterMode, type TextureFormat, type TextureFormatInfo, type TextureImageElement, type TextureMipmapData, type TextureMipmapLevelData, type TextureSampler, type TextureType, type TextureTypeDetail, type TextureVideo, type TypeDetailInfo, type UniformBufferLayout, type UniformLayout, VERTEX_ATTRIB_BLEND_INDICES, VERTEX_ATTRIB_BLEND_WEIGHT, VERTEX_ATTRIB_DIFFUSE, VERTEX_ATTRIB_NORMAL, VERTEX_ATTRIB_POSITION, VERTEX_ATTRIB_TANGENT, VERTEX_ATTRIB_TEXCOORD0, VERTEX_ATTRIB_TEXCOORD1, VERTEX_ATTRIB_TEXCOORD2, VERTEX_ATTRIB_TEXCOORD3, VERTEX_ATTRIB_TEXCOORD4, VERTEX_ATTRIB_TEXCOORD5, VERTEX_ATTRIB_TEXCOORD6, VERTEX_ATTRIB_TEXCOORD7, type VertexAttribFormat, type VertexBufferInfo, VertexData, type VertexLayout, type VertexLayoutOptions, type VertexSemantic, type VertexStepMode, type WebGLContext, genDefaultName, getTextureFormatBlockHeight, getTextureFormatBlockSize, getTextureFormatBlockWidth, getVertexAttribByName, getVertexAttribFormat, getVertexAttribName, getVertexAttributeFormat, getVertexAttributeIndex, getVertexBufferAttribType, getVertexBufferAttribTypeBySemantic, getVertexBufferLength, getVertexBufferStride, getVertexFormatComponentCount, getVertexFormatSize, hasAlphaChannel, hasBlueChannel, hasDepthChannel, hasGreenChannel, hasRedChannel, hasStencilChannel, isCompressedTextureFormat, isFloatTextureFormat, isIntegerTextureFormat, isSRGBTextureFormat, isSignedTextureFormat, linearTextureFormatToSRGB, makeVertexBufferType, matchVertexBuffer, semanticList };
+export { type AbstractDevice, type ArrayTypeDetail, type AtlasInfo, type AtomicTypeInfoDetail, type BaseCreationOptions, BaseDevice, type BaseTexture, type BindGroup, type BindGroupLayout, type BindGroupLayoutEntry, type BindPointInfo, type BlendEquation, type BlendFunc, type BlendingState, type BufferBindingLayout, type BufferCreationOptions, type BufferUsage, CPUTimer, type ColorState, type CompareFunc, type ComputeProgramConstructParams, type DataType, type DepthState, type DeviceBackend, type DeviceCaps, type DeviceEventMap, type DeviceOptions, type DeviceViewport, DrawText, type DrawTextLayoutOptions, type ExpValueNonArrayType, type ExpValueType, type ExternalTextureBindingLayout, type FaceMode, type FaceWinding, Font, type FrameBuffer, type FrameBufferOptions, type FrameBufferTextureAttachment, type FrameInfo, type FramebufferCaps, type FunctionTypeDetail, type GPUDataBuffer, type GPUObject, type GPUObjectList, type GPUProgram, type GPUProgramConstructParams, GPUResourceUsageFlags, GlyphManager, type ITimer, type IndexBuffer, MAX_BINDING_GROUPS, MAX_TEXCOORD_INDEX_COUNT, MAX_VERTEX_ATTRIBUTES, type MiscCaps, PBAddressSpace, PBAnyTypeInfo, PBArrayTypeInfo, PBAtomicI32TypeInfo, PBAtomicU32TypeInfo, PBBuiltinScope, type PBComputeOptions, PBDoWhileScope, PBForScope, PBFunctionScope, PBFunctionTypeInfo, PBGlobalScope, PBIfScope, PBInputScope, PBInsideFunctionScope, PBLocalScope, PBNakedScope, PBOutputScope, PBPointerTypeInfo, PBPrimitiveType, PBPrimitiveTypeInfo, PBReflection, type PBReflectionTagGetter, type PBRenderOptions, PBSamplerAccessMode, PBSamplerTypeInfo, PBScope, PBShaderExp, type PBStructLayout, PBStructTypeInfo, PBTextureType, PBTextureTypeInfo, PBTypeInfo, PBVoidTypeInfo, PBWhileScope, type PointerTypeDetail, Pool, type PrimitiveType, type PrimitiveTypeDetail, ProgramBuilder, Proxiable, type RasterizerState, type RenderBundle, type RenderProgramConstructParams, type RenderStateSet, type SamplerBindingLayout, type SamplerOptions, type SamplerTypeDetail, type ShaderCaps, type ShaderExpTagRecord, type ShaderExpTagValue, type ShaderKind, ShaderType, type ShaderTypeFunc, type StencilOp, type StencilState, type StorageTextureBindingLayout, type StructTypeDetail, type StructuredBuffer, StructuredBufferData, type StructuredValue, type TextHorizontalAlignment, type TextVerticalAlignment, type Texture2D, type Texture2DArray, type Texture3D, type TextureAddressMode, TextureAtlasManager, type TextureBindingLayout, type TextureCaps, type TextureColorSpace, type TextureCreationOptions, type TextureCube, type TextureFilterMode, type TextureFormat, type TextureFormatInfo, type TextureImageElement, type TextureMipmapData, type TextureMipmapLevelData, type TextureSampler, type TextureType, type TextureTypeDetail, type TextureVideo, type TypeDetailInfo, type UniformBufferLayout, type UniformLayout, VERTEX_ATTRIB_BLEND_INDICES, VERTEX_ATTRIB_BLEND_WEIGHT, VERTEX_ATTRIB_DIFFUSE, VERTEX_ATTRIB_NORMAL, VERTEX_ATTRIB_POSITION, VERTEX_ATTRIB_TANGENT, VERTEX_ATTRIB_TEXCOORD0, VERTEX_ATTRIB_TEXCOORD1, VERTEX_ATTRIB_TEXCOORD2, VERTEX_ATTRIB_TEXCOORD3, VERTEX_ATTRIB_TEXCOORD4, VERTEX_ATTRIB_TEXCOORD5, VERTEX_ATTRIB_TEXCOORD6, VERTEX_ATTRIB_TEXCOORD7, type VertexAttribFormat, type VertexBufferInfo, VertexData, type VertexLayout, type VertexLayoutOptions, type VertexSemantic, type VertexStepMode, type WebGLContext, genDefaultName, getTextureFormatBlockHeight, getTextureFormatBlockSize, getTextureFormatBlockWidth, getVertexAttribByName, getVertexAttribFormat, getVertexAttribName, getVertexAttributeFormat, getVertexAttributeIndex, getVertexBufferAttribType, getVertexBufferAttribTypeBySemantic, getVertexBufferLength, getVertexBufferStride, getVertexFormatComponentCount, getVertexFormatSize, hasAlphaChannel, hasBlueChannel, hasDepthChannel, hasGreenChannel, hasRedChannel, hasStencilChannel, isCompressedTextureFormat, isFloatTextureFormat, isIntegerTextureFormat, isSRGBTextureFormat, isSignedTextureFormat, linearTextureFormatToSRGB, makeVertexBufferType, matchVertexBuffer, semanticList };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zephyr3d/device",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "description": "Device API for zephyr3d",
   "homepage": "https://github.com/gavinyork/zephyr3d#readme",
   "type": "module",
@@ -68,7 +68,7 @@
     "@rollup/plugin-commonjs": "~28.0.2",
     "@types/node": "^22.12.0",
     "@webgpu/types": "^0.1.65",
-    "@zephyr3d/base": "^0.2.3",
+    "@zephyr3d/base": "^0.2.7",
     "rollup-plugin-import-css": "~3.5.8"
   },
   "scripts": {