Files
EVEngine/docs/usr/modules/graphics.md
T
西风逍遥游 7437224c90 api(graphics): align C++/script names, validate sampler strings, document error contracts
- Add RGBA-float drawSolidRect/drawTexturedRect overloads so the C++ names
  match the script-facing API (script already bound those names).
- Add string-based setTextureSampler(Texture*, filter, mipmap, aniso, lodBias)
  overload with strict magic-string validation (unknown filter/mipmap now
  throws instead of silently falling back to linear); keep
  setTextureSamplerParams as a deprecated alias. Script binding now targets
  the overload with an explicit cast.
- Document error contracts: DataModule encode/decode (new[] ownership +
  throws), Filesystem setSource/mount/unmount (false on recoverable failure,
  no throw), ModelData getMesh vs numeric getters (nullptr vs throw), plus a
  two-state error-semantics section in API-CONVENTIONS.md.
- Tests: TextureSampler string validation (valid + deprecated alias + typo
  throws), headless test now exercises the RGBA-float overloads.
2026-08-22 02:30:12 +08:00

13 KiB
Raw Blame History

图形渲染模块

脚本入口: eve.Graphics()

清屏、2D 图元、纹理、Canvas、摄像机和 3D 渲染。Camera2D/Camera3D 提供屏幕与世界坐标换算,供 2D/3D 拾取使用;形状命中测试见 Math,物理体查询见 Physics。

基本用法

gfx.setBackgroundColor(0.08, 0.1, 0.16, 1.0);
gfx.clear();
gfx.drawSolidRect(40, 40, 160, 80, 0.2, 0.7, 1.0, 1.0);

对象关系与调用时机

Graphics 管理设备、swapchain、camera、light 和提交;Texture/Shader/Mesh/Renderable 是资源或场景对象。CPU 资源创建在 init,帧内只更新参数并 draw。

目标导向指南

绘制 2D 游戏帧

在 eve_render() 开始调用 clear(),随后按背景、地图、角色、粒子、UI 的顺序提交。纯色占位使用 drawSolidRect();已有 Texture 使用 drawTexturedRect()。正常主循环由引擎负责 present。

渲染带光照的 3D 对象

初始化时创建 mesh、shader 和 renderable,设置 camera、ambient 和 directional light;每帧只更新 transform/material 参数,最后调用 render3D()。阴影开关、bias 和 strength 应逐场景调节。

纹理过滤(mipmap / 各向异性 / LOD)

默认 newTexture 仍为线性过滤、单级 mip(兼容旧行为)。需要三线性与各向异性时:

// generateMipmaps=true, maxAnisotropy=16, filter/mipmap="linear", lodBias=0
tex <- gfx.newTextureWithSampler(img, false, false, true, 16.0, "linear", "linear", 0.0);
print(tex.getMipmapCount());
gfx.setTextureSampler(tex, "nearest", "none", 1.0, 0.0); // 像素风
print(gfx.getMaxAnisotropy());

C++ 侧使用 TextureCreateInfo::withMipmaps() / TextureSampler::anisotropic(),并通过同名 setTextureSampler 重载热更新采样状态(字符串版参数与脚本一致;旧名 setTextureSamplerParams 保留为弃用别名)。filter 只接受 nearest/linear,mipmap 只接受 none/nearest/linear,传错会抛异常而不是静默回退。Cubemap(IBL)默认生成完整 mip 链,供 textureLod 按粗糙度采样。

几何 LOD:Renderable3D.setMeshLod(index, mesh, switchDistance),RenderSystem3D 按相机距离选择网格。

材质(Material)与模型部件

把着色方法(pbr / unlit / hair / custom)、贴图和 PBR 参数打成一个 Material,挂到整模或某个部件:

local mat = gfx.newMaterial();
mat.setShadingModel("pbr");
mat.setAlbedoTexture(albedo);
mat.setNormalTexture(nrm);
mat.setMetallic(0.2);
mat.setRoughness(0.5);

local r = Renderable3D.create();
r.setMaterial(mat);                 // 整模
// 或多部件:r.setPart(0, "body", bodyMesh, bodyMat);

可编译渲染控制与 GBuffer

RenderControl 用字符串特性开关,再 compile() 成有序 Pass(默认:shadow → forward → hair):

local rc = gfx.getRenderControl();
rc.enable("gbuffer");      // 额外填充可采样深度/法线
rc.enable("gbufferAlbedo");
rc.compile();
gfx.render3D();
local gb = rc.getGBuffer();
if (gb.isValid()) {
    local depth = gb.getDepthTexture();     // RGBA8,R = 线性深度 0..1(Canvas / 体积雾)
    local hwDepth = gb.getHwDepthTexture(); // D32,.r = Vulkan NDC z(3D AO / GI)
    local nrm = gb.getNormalTexture();      // RGB = 法线*0.5+0.5
}

3D 前向仍启用硬件 z-buffer;GBuffer 是给 AO / 体积雾 / 风格描边等中后期用的采样目标。阴影仍走 CSM shadow map。

一帧里各 buffer 谁写谁读、对应函数和 shader,见开发文档 3D渲染管线.md。

大面积平铺 albedo(地面、墙面)若出现明显重复,可对实体调用 setTexCellBomb(cellScale, strength, rotAmount=1):按 UV 划分 cell,对邻接 cell 做随机偏移/旋转并混合。strength=0(默认)关闭,行为与原先一致;cellScale 一般为 2~16。

砖墙、石板等需要假深度时,用 setHeightTexture(heightTex) + setParallax(scale, minLayers=8, maxLayers=32) 开启视差遮蔽贴图(POM)。高度图取 R 通道(白=凸起朝向观察者);scale=0(默认)关闭。典型 scale 为 0.02~0.08;掠射角下层数会自适应增加。

毛发 / 皮毛渲染(Hair Cards)

适用于 VRoid / 角色发片、动物皮毛等 alpha 卡片网格。引擎提供内置 Kajiya-Kay 各向异性高光 shader,并在 RenderSystem3D 中于不透明物体之后、按距离从远到近绘制。

local hairShader = gfx.newHairShader()
hairShader.sendFloat("specExp", 90.0)
hairShader.sendFloat("specStrength", 0.9)
hairShader.sendFloat("alphaCutoff", 0.12)

local hair = Renderable3D.create()
hair.setMesh(hairCardMesh)
hair.setTexture(hairAlbedo)
hair.setShader(hairShader)
hair.setHair(true)   // 启用透明毛发 pass(背面优先排序)
hair.setCastShadow(false)  // 发片通常不参与阴影投射

可调 push 参数:specExp、specStrength、primaryShift、secondaryShift、alphaCutoff、rimStrength、strandDirX/Y/Z(发束方向,全 0 时由顶点自动推导)。

屏幕空间体积光(尘雾光柱)与体积雾

vol <- gfx.newVolumetric()。setQuality("low"|"medium"|"high") 控制采样与 resolutionFor。

  • screenspace:beginOcclusionMap → drawOccluders2D → scatter;或 applyFromScene
  • raymarch:setMode("raymarch") + setCamera + 线性深度 → rayMarch
  • fog:setMode("fog") + setFogHeight* / setFogStart/End + 线性深度 → applyFog(雾色 alpha 叠加场景)

细节见 体积光模块设计.md。

屏幕空间环境光遮蔽(SSAO / HBAO / GTAO)

ao <- gfx.newAmbientOcclusion()。setMode("ssao"|"hbao"|"gtao"),setQuality 控制采样与 resolutionFor。

  1. setCamera + 线性深度纹理(与体积雾相同约定)
  2. compute / computeTo → AO 图(RGB=遮蔽因子,A=深度)
  3. 可选 blur / blurTo(双边)
  4. applyOverlay 以黑 + alpha=(1-ao)*intensity 叠到已有场景

3D 默认路径:RenderControl 特性 "ao"(默认开)会在 forward 之后对 GBuffer 的 D32 + 法线做 applyFromGBuffer,不必手动建 Canvas。Canvas 上的 compute 仍用 8-bit 线性深度。

细节见 环境光遮蔽模块设计.md。

屏幕空间全局光照(SSGI)

gi <- gfx.newGlobalIllumination()。setQuality 控制采样数与半径;setLightDirection / setLightColor 提供反弹用的太阳光。

3D 默认路径:RenderControl 特性 "gi" 仍默认开(mesh 半球天空/地面 + wrap fill)。fullscreen applyFromScene 不会自动叠到 3D 回读:从 lit scene color 采样会把帘子/花盆印到地面上形成游走鬼影。需要时仍可手动 applyFromScene / applyFromDepth。Canvas 测试仍可用打包的 applyFromDepth(A=线性深度)。

local rc = gfx.getRenderControl();
rc.enable("gi");   // 默认已开
rc.compile();

抗锯齿(硬件 MSAA + 经典后处理)

硬件 MSAA(3D 模型/体素边缘效果最好):3D scene color pass 默认 4x 多重采样再 resolve。用 RenderControl "msaa"(默认开)开关,gfx.setMsaaSamples(n) 设采样数(0/1=关,2/4/8 按设备能力 clamp):

gfx.setMsaaSamples(8);          // 升到 8x(若设备支持)
gfx.setMsaaSamples(0);          // 关闭硬件 MSAA
rc.disable("msaa");             // 或通过 RenderControl 特性关

经典后处理:aa <- gfx.newAntiAliasing()。setQuality("low"|"medium"|"high") 调整阈值与搜索;setMode 选择算法:

  • fxaa:FXAA 3.11 风格亮度边搜索
  • smaa:SMAA 启发的单 Pass 形态学 AA
  • ssaa:超采样 Resolve(先画到 resolutionFor 尺寸的 Canvas)
  • nfaa:沿亮度梯度切向的 Normal Filter AA

典型流程:场景 → Canvas → aa.applyCanvas / applyCanvasTo → 屏幕。

3D 默认路径:begin3DFrame 画到可采样的 scene color("msaa" 开时先 Nx 多重采样再 resolve 到 1x),present 时按 RenderControl "aa"(默认开)做 FXAA resolve 再叠 AO/HUD。手动 Canvas 路径仍然可用。细节见 抗锯齿模块设计.md。

2D 屏幕拾取

Camera2D 用 setPosition / setZoom 控制视口中心与缩放;screenToWorldX/Y(screenX, screenY, viewW, viewH) 把鼠标像素换成世界坐标(viewW/H 通常取 gfx.getWidth/Height),再交给 Math 的 pointIn* 或 Physics 的 testPoint / queryAABB。

3D 屏幕拾取

Camera3D.screenToRay(screenX, screenY, viewW, viewH) 写入眼点与单位方向,用 getScreenRayOrigin* / getScreenRayDir* 读取,再对包围球/盒调用 Math 的 raycastSphere / raycastBox。

常见问题

  • 忘记每帧 clear(),保留未定义的旧帧内容。
  • 每帧编译 shader 或上传纹理。
  • 2D/UI/3D 提交顺序错误导致覆盖。
  • 拾取时 viewW/H 与实际渲染 drawable 不一致,射线会偏。

API 快查

下列方法名来自当前 Squirrel 绑定;同一模块创建的辅助对象(例如 World、Body、Source)的方法也列在这里。

  • bakeMeshMorph()、clear()、clearMorphWeights()、declareFloat()、declareMatrix()、declareVec2()、declareVec3()、declareVec4()
  • drawSolidRect()、drawTexturedRect()、drawOcclusionSolid()、drawOcclusionTexture()、getCastShadow()、getCastOcclusion()、getDirX()、getDirY()、getDirZ()、getHeight()、getMorphCount()
  • getMorphName()、getMorphWeight()、getName()、getRadius()、getScreenRayDirX()、getScreenRayDirY()、getScreenRayDirZ()、getScreenRayOriginX()
  • getScreenRayOriginY()、getScreenRayOriginZ()、getShader()、getShadowBias()、getShadowStrength()、getType()、getUniformIndex()、getVertexCount()
  • getVolumetric()、getVolumetricIntensity()、getWidth()、getX()、getY()、getYaw()、getZ()、getZoom()、hasMorph()、hasMorphData()
  • hasUniform()、isEnabled()、isMorphDirty()、newHairShader()、newMeshCylinder()、newMeshShader()、newMeshSphere()、newQuad()、newShader()
  • newShaderFromSpvFile()、newTexture()、newTextureWithSampler()、setTextureSampler()、getMaxAnisotropy()、newVolumetric()、newAmbientOcclusion()、newGlobalIllumination()、newAntiAliasing()、setMsaaSamples()、getMsaaSamples()、present()、render3D()、reset()、screenToRay()、screenToWorldX()、screenToWorldY()
  • sendFloat()、sendVec2()、sendVec3()、sendVec4()、setActive()、setAmbient()、setBackgroundColor()、setCamera()
  • setCanvas()、setCastOcclusion()、setCastShadow()、setColor()、setDirection()、setDirectionalLight()、setEnabled()、setEnvIntensity()、setEnvMap()
  • setEye()、setFov()、setMesh()、setMeshLod()、clearMeshLod()、getMeshLodCount()、getMeshLodLevelAtDistance()、setMetallic()、setMorphWeight()、setNormalTexture()、setHeightTexture()、setPosition()、setRadius()
  • setReceiveLight()、setReceiveShadow()、setRotation()、setRoughness()、setScale()、setShader()、setHair()、getHair()、setShadowBias()、setShadowStrength()
  • setTarget()、setTexCellBomb()、getTexCellBombScale()、getTexCellBombStrength()、getTexCellBombRotation()、setParallax()、getParallaxScale()、getParallaxMinLayers()、getParallaxMaxLayers()、setTexture()、setTint()、setType()、setUp()、setViewport()、setVisible()、setVolumetric()、setVolumetricIntensity()、setYaw()
  • setZoom()、worldToScreenX()、worldToScreenY()、Texture.getMipmapCount()
  • Volumetric:setQuality、setMode、scatter、applyFromScene、rayMarch、applyFog、setFogHeight、setFogStart、setFogEnd、setCamera、setLightDirection、setDensity 等
  • AmbientOcclusion:setQuality、setMode、setCamera、setRadius、setBias、setIntensity、setPower、compute、blur、applyOverlay、applyFromDepth、resolutionFor 等
  • GlobalIllumination:setQuality、setCamera、setRadius、setIntensity、setLightDirection、setLightColor、applyFromDepth、getSampleCount 等
  • AntiAliasing:setQuality、setMode、apply、applyTo、applyCanvas、applyCanvasTo、suggestScale、resolutionFor、setFloat、getFloat 等

使用要点

  • 模块对象和它创建的资源对象应保存在全局或实体状态中,不要在每帧重复创建。
  • 带 update(dt) 的系统应在 eve_update 调用;绘制方法应在 eve_render 调用。
  • 参数约束、默认值和返回类型以对应模块头文件及 addFunc 绑定为准;本文 API 快查与当前源码同步生成。

源码: src/modules/graphics/ 相关测试: 在 test/ 中搜索 graphics、Camera2D、Camera3D。