Add scissor rect

STREGA · STREGA · commit c58ba419234c · 2023-12-27T23:59:21.000-05:00
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/OpenGL_GateEngine.swift b/Dependencies/OpenGL/OpenGL_GateEngine/OpenGL_GateEngine.swift
@@ -1041,8 +1041,12 @@ public func glUniform4f(location: GLint, value1: Float, value2: Float, value3: F
     _glDeleteVertexArrays(GLsizei(arrays.count), arrays)
 }
 
-@inlinable @inline(__always) public func glViewport<T: BinaryInteger>(x: T, y: T, width: T, height: T) {
-    _glViewport(GLint(x), GLint(y), GLsizei(width), GLsizei(height))
+@inlinable @inline(__always) public func glViewport(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
+    _glViewport(x, y, width, height)
+}
+
+@inlinable @inline(__always) public func glScissor(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {
+    _glScissor(x, y, width, height)
 }
 
 @inlinable @inline(__always) public func glGetString(describing name: OpenGL.Description) throws -> String  {
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Apple/GLKit.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Apple/GLKit.swift
@@ -456,6 +456,10 @@ public typealias GLdouble = GLKit.GLdouble
     GLKit.glViewport(x, y, width, height)
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    GLKit.glScissor(x, y, width, height)
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     return GLKit.glGetString(name)
 }
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/GLEW/GLEW_Linux.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/GLEW/GLEW_Linux.swift
@@ -455,6 +455,10 @@ public func glewInit() {
     GLEW.__glewViewport(x, y, width, height)
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    GLEW.__glewScissor(x, y, width, height)
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     return GLEW.__glewGetString(name)
 }
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/GLEW/GLEW_Windows.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/GLEW/GLEW_Windows.swift
@@ -448,6 +448,10 @@ public func glewInit() {
     GLEW.glViewport(x, y, width, height)
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    GLEW.glScissor(x, y, width, height)
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     return GLEW.glGetString(name)
 }
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Linux/OpenGLLinux.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Linux/OpenGLLinux.swift
@@ -454,6 +454,10 @@ public typealias GLdouble = OpenGL_Linux.GLdouble
     OpenGL_Linux.glViewport(x, y, width, height)
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    OpenGL_Linux.glScissor(x, y, width, height)
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     return OpenGL_Linux.glGetString(name)
 }
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Unsupported/Unsupported.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Unsupported/Unsupported.swift
@@ -456,6 +456,10 @@ public typealias GLdouble = Double
     fatalError("OpenGL Not Supported")
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    fatalError("OpenGL Not Supported")
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     fatalError("OpenGL Not Supported")
 }
diff --git a/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Windows/OpenGLWindows.swift b/Dependencies/OpenGL/OpenGL_GateEngine/Platforms/Windows/OpenGLWindows.swift
@@ -453,6 +453,10 @@ public typealias GLdouble = OpenGL_Windows.GLdouble
     OpenGL_Windows.glViewport(x, y, width, height)
 }
 
+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {
+    OpenGL_Windows.glScissor(x, y, width, height)
+}
+
 @_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {
     return OpenGL_Windows.glGetString(name)
 }
diff --git a/Sources/GateEngine/System/Rendering/Drawables/Canvas.swift b/Sources/GateEngine/System/Rendering/Drawables/Canvas.swift
@@ -9,7 +9,14 @@
 @MainActor public struct Canvas {
     let interfaceScale: Float
     internal var viewOrigin: Position2? = nil
-    internal var clipRect: Rect? = nil
+    internal var viewport: Rect? = nil
+    private var _scissorRect: Rect? = nil
+    internal var scissorRect: Rect? {
+        if let _scissorRect {
+            return _scissorRect * interfaceScale
+        }
+        return nil
+    }
 
     internal var size: Size2? = nil
     internal var camera: Camera? = nil
@@ -37,13 +44,17 @@
         self.viewOrigin = viewOrigin
     }
     
+    public mutating func setViewport(_ viewport: Rect?) {
+        self.viewport = viewport
+    }
+    
     /**
      Applys a clip rectangle to all content in this Canvas.
      
      - parameter clipRect: The area within this Rect will be drawn.
      */
-    public mutating func setClipRect(_ clipRect: Rect?) {
-        self.clipRect = clipRect
+    public mutating func setScissorRect(_ scissorRect: Rect?) {
+        self._scissorRect = scissorRect
     }
 
     public mutating func insert(
@@ -163,6 +174,7 @@
         scale: Size2 = .one,
         depth: Float = 0,
         opacity: Float = 1,
+        sampleFilter: Material.Channel.SampleFilter = .linear,
         flags: CanvasElementSpriteFlags = .default
     ) {
         let position = Position3(position.x, position.y, depth * -1)
@@ -173,6 +185,7 @@
         let material = Material { material in
             material.channel(0) { channel in
                 channel.texture = texture
+                channel.sampleFilter = sampleFilter
                 if let subRect {
                     channel.offset = Position2(
                         (subRect.position.x + 0.001) / Float(texture.size.width),
diff --git a/Sources/GateEngine/System/Rendering/Drawables/Scene.swift b/Sources/GateEngine/System/Rendering/Drawables/Scene.swift
@@ -9,6 +9,7 @@
 @MainActor public struct Scene {
     @usableFromInline internal var camera: Camera
     @usableFromInline internal var viewport: Rect?
+    @usableFromInline internal var scissorRect: Rect?
 
     @usableFromInline internal var pointLights: Set<ScenePointLight> = []
     @usableFromInline internal var spotLights: Set<SceneSpotLight> = []
@@ -36,6 +37,11 @@
     public mutating func setViewport(_ viewport: Rect?) {
         self.viewport = viewport
     }
+    
+    @inlinable @inline(__always)
+    public mutating func setScissorRect(_ scissorRect: Rect?) {
+        self.scissorRect = scissorRect
+    }
 
     /** Adds geometry to the scene for rendering.
     - parameter geometry: The geometry to draw.
@@ -345,7 +351,7 @@
         return false
     }
 
-    public init(camera: Camera, viewport: Rect? = nil, estimatedCommandCount: Int = 10) {
+    public init(camera: Camera, viewport: Rect? = nil, clipRect: Rect? = nil, estimatedCommandCount: Int = 10) {
         self.camera = camera
         self.viewport = viewport
 
diff --git a/Sources/GateEngine/System/Rendering/Platforms/DirectX12/DX12RenderTarget.swift b/Sources/GateEngine/System/Rendering/Platforms/DirectX12/DX12RenderTarget.swift
@@ -246,7 +246,7 @@ class DX12RenderTarget: RenderTargetBackend {
         renderer.cachedContent.removeAll(keepingCapacity: true)
     }
 
-    func willBeginContent(matrices: Matrices?, viewport: GameMath.Rect?) {
+    func willBeginContent(matrices: Matrices?, viewport: GameMath.Rect?, scissorRect: GameMath.Rect?) {
         do {
             try self.commandList.reset(
                 usingOriginalAllocator: commandAllocator,
@@ -267,16 +267,20 @@ class DX12RenderTarget: RenderTargetBackend {
                 self.commandList.setViewports([
                     D3DViewport(width: viewport.size.width, height: viewport.size.height)
                 ])
+            } else {
+                self.commandList.setViewports([D3DViewport(width: size.width, height: size.height)])
+            }
+            
+            if let scissorRect: Rect = scissorRect {
                 self.commandList.setScissorRects([
                     D3DRect(
-                        x: Int(viewport.position.x),
-                        y: Int(viewport.position.y),
-                        width: Int(viewport.size.width),
-                        height: Int(viewport.size.height)
+                        x: Int(scissorRect.position.x),
+                        y: Int(scissorRect.position.y),
+                        width: Int(scissorRect.size.width),
+                        height: Int(scissorRect.size.height)
                     )
                 ])
             } else {
-                self.commandList.setViewports([D3DViewport(width: size.width, height: size.height)])
                 self.commandList.setScissorRects([
                     D3DRect(x: 0, y: 0, width: Int(size.width), height: Int(size.height))
                 ])
diff --git a/Sources/GateEngine/System/Rendering/Platforms/Metal/MetalRenderTarget.swift b/Sources/GateEngine/System/Rendering/Platforms/Metal/MetalRenderTarget.swift
@@ -107,7 +107,7 @@ final class MetalRenderTarget: RenderTargetBackend {
         #endif
     }
 
-    func willBeginContent(matrices: Matrices?, viewport: GameMath.Rect?) {
+    func willBeginContent(matrices: Matrices?, viewport: GameMath.Rect?, scissorRect: GameMath.Rect?) {
         if let viewport {
             let mtlViewport = MTLViewport(
                 originX: Double(viewport.position.x),
@@ -119,6 +119,15 @@ final class MetalRenderTarget: RenderTargetBackend {
             )
             self.commandEncoder.setViewport(mtlViewport)
         }
+        if let scissorRect {
+            let mtlScissorRect = MTLScissorRect(
+                x: Int(Double(scissorRect.position.x)),
+                y: Int(Double(scissorRect.position.y)),
+                width: Int(Double(scissorRect.size.width)),
+                height: Int(Double(scissorRect.size.height))
+            )
+            self.commandEncoder.setScissorRect(mtlScissorRect)
+        }
     }
 
     func didEndContent() {
diff --git a/Sources/GateEngine/System/Rendering/Platforms/OpenGL/OpenGLRenderTarget.swift b/Sources/GateEngine/System/Rendering/Platforms/OpenGL/OpenGLRenderTarget.swift
@@ -7,7 +7,7 @@
 #if canImport(OpenGL_GateEngine)
 import OpenGL_GateEngine
 
-class OpenGLRenderTarget: RenderTargetBackend {
+final class OpenGLRenderTarget: RenderTargetBackend {
     let framebuffer: GLuint
 
     let colorTexture: GLuint
@@ -102,7 +102,8 @@ extension OpenGLRenderTarget {
     func didEndFrame(_ frame: UInt) {
         if let windowRenderTarget {
             glBindFramebuffer(0)
-            glViewport(x: 0, y: 0, width: Int(size.width), height: Int(size.height))
+            glViewport(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
+            glScissor(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
             let renderer: Renderer = Game.shared.renderer
             let sizeOnlyRenderTarget = renderer.openGLBackend.sizeOnlyRenderTarget
             sizeOnlyRenderTarget.size = self.size
@@ -116,17 +117,28 @@ extension OpenGLRenderTarget {
         glFlush()
     }
 
-    func willBeginContent(matrices: Matrices?, viewport: Rect?) {
+    func willBeginContent(matrices: Matrices?, viewport: Rect?, scissorRect: Rect?) {
         glBindFramebuffer(framebuffer)
-        if let viewport = viewport {
+        if let viewport {
             glViewport(
-                x: Int(viewport.position.x),
-                y: Int(viewport.position.y),
-                width: Int(viewport.size.width),
-                height: Int(viewport.size.height)
+                x: GLint(viewport.position.x),
+                y: GLint(viewport.position.y),
+                width: GLsizei(viewport.size.width),
+                height: GLsizei(viewport.size.height)
             )
         } else {
-            glViewport(x: 0, y: 0, width: Int(size.width), height: Int(size.height))
+            glViewport(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
+        }
+        
+        if let scissorRect {
+            glScissor(
+                x: GLint(scissorRect.x), 
+                y: GLint(scissorRect.y), 
+                width: GLsizei(scissorRect.width), 
+                height: GLsizei(scissorRect.height)
+            )
+        }else{
+            glScissor(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
         }
     }
 
diff --git a/Sources/GateEngine/System/Rendering/Platforms/WebGL2/WebGL2RenderTarget.swift b/Sources/GateEngine/System/Rendering/Platforms/WebGL2/WebGL2RenderTarget.swift
@@ -10,7 +10,7 @@ import WebGL1
 import WebGL2
 import GameMath
 
-class WebGL2RenderTarget: RenderTargetBackend {
+final class WebGL2RenderTarget: RenderTargetBackend {
     let context: WebGL2RenderingContext
     let framebuffer: WebGLFramebuffer?
 
@@ -215,9 +215,30 @@ extension WebGL2RenderTarget {
         }
     }
 
-    func willBeginContent(matrices: Matrices?, viewport: Rect?) {
+    func willBeginContent(matrices: Matrices?, viewport: Rect?, scissorRect: Rect?) {
         context.bindFramebuffer(target: GL.FRAMEBUFFER, framebuffer: framebuffer)
-        context.viewport(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
+        
+        if let viewport {
+            context.viewport(
+                x: GLint(viewport.x), 
+                y: GLint(viewport.y), 
+                width: GLsizei(viewport.width), 
+                height: GLsizei(viewport.height)
+            )
+        }else{
+            context.viewport(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
+        }
+        
+        if let scissorRect {
+            context.scissor(
+                x: GLint(scissorRect.x), 
+                y: GLint(scissorRect.y), 
+                width: GLsizei(scissorRect.width), 
+                height: GLsizei(scissorRect.height)
+            )
+        }else{
+            context.viewport(x: 0, y: 0, width: GLsizei(size.width), height: GLsizei(size.height))
+        }
     }
     func didEndContent() {
         context.flush()
diff --git a/Sources/GateEngine/System/Rendering/RenderTarget.swift b/Sources/GateEngine/System/Rendering/RenderTarget.swift
@@ -203,7 +203,7 @@ extension _RenderTargetProtocol {
     private func drawScene(_ scene: Scene) {
         let matrices = scene.camera.matricies(withAspectRatio: self.size.aspectRatio)
 
-        renderTargetBackend.willBeginContent(matrices: matrices, viewport: scene.viewport)
+        renderTargetBackend.willBeginContent(matrices: matrices, viewport: scene.viewport, scissorRect: scene.scissorRect)
         for command in scene._drawCommands {
             Game.shared.renderer.draw(
                 command,
@@ -219,7 +219,7 @@ extension _RenderTargetProtocol {
     private func drawCanvas(_ canvas: Canvas) {
         let matrices = canvas.matrices(withSize: self.size)
 
-        renderTargetBackend.willBeginContent(matrices: matrices, viewport: canvas.clipRect)
+        renderTargetBackend.willBeginContent(matrices: matrices, viewport: canvas.viewport, scissorRect: canvas.scissorRect)
         for command in canvas._drawCommands {
             Game.shared.renderer.draw(
                 command,
@@ -234,7 +234,7 @@ extension _RenderTargetProtocol {
     @inline(__always)
     private func drawRenderTarget(_ container: RenderTargetFillContainer, frame: UInt) {
         container.renderTarget.draw(frame)
-        renderTargetBackend.willBeginContent(matrices: nil, viewport: nil)
+        renderTargetBackend.willBeginContent(matrices: nil, viewport: nil, scissorRect: nil)
         Game.shared.renderer.draw(
             container.renderTarget,
             into: self,
@@ -311,7 +311,7 @@ extension RenderTargetProtocol {
     func willBeginFrame(_ frame: UInt)
     func didEndFrame(_ frame: UInt)
 
-    func willBeginContent(matrices: Matrices?, viewport: Rect?)
+    func willBeginContent(matrices: Matrices?, viewport: GameMath.Rect?, scissorRect: GameMath.Rect?)
     func didEndContent()
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1041,8 +1041,12 @@ public func glUniform4f(location: GLint, value1: Float, value2: Float, value3: F`
`1041`	`1041`	`_glDeleteVertexArrays(GLsizei(arrays.count), arrays)`
`1042`	`1042`	`}`
`1043`	`1043`
`1044`		`-@inlinable @inline(__always) public func glViewport<T: BinaryInteger>(x: T, y: T, width: T, height: T) {`
`1045`		`- _glViewport(GLint(x), GLint(y), GLsizei(width), GLsizei(height))`
	`1044`	`+@inlinable @inline(__always) public func glViewport(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {`
	`1045`	`+ _glViewport(x, y, width, height)`
	`1046`	`+}`
	`1047`	`+`
	`1048`	`+@inlinable @inline(__always) public func glScissor(x: GLint, y: GLint, width: GLsizei, height: GLsizei) {`
	`1049`	`+ _glScissor(x, y, width, height)`
`1046`	`1050`	`}`
`1047`	`1051`
`1048`	`1052`	`@inlinable @inline(__always) public func glGetString(describing name: OpenGL.Description) throws -> String {`
Original file line number	Diff line number	Diff line change
`@@ -456,6 +456,10 @@ public typealias GLdouble = GLKit.GLdouble`
`456`	`456`	`GLKit.glViewport(x, y, width, height)`
`457`	`457`	`}`
`458`	`458`
	`459`	`+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {`
	`460`	`+ GLKit.glScissor(x, y, width, height)`
	`461`	`+}`
	`462`	`+`
`459`	`463`	`@_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {`
`460`	`464`	`return GLKit.glGetString(name)`
`461`	`465`	`}`
Original file line number	Diff line number	Diff line change
`@@ -455,6 +455,10 @@ public func glewInit() {`
`455`	`455`	`GLEW.__glewViewport(x, y, width, height)`
`456`	`456`	`}`
`457`	`457`
	`458`	`+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {`
	`459`	`+ GLEW.__glewScissor(x, y, width, height)`
	`460`	`+}`
	`461`	`+`
`458`	`462`	`@_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {`
`459`	`463`	`return GLEW.__glewGetString(name)`
`460`	`464`	`}`
Original file line number	Diff line number	Diff line change
`@@ -448,6 +448,10 @@ public func glewInit() {`
`448`	`448`	`GLEW.glViewport(x, y, width, height)`
`449`	`449`	`}`
`450`	`450`
	`451`	`+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {`
	`452`	`+ GLEW.glScissor(x, y, width, height)`
	`453`	`+}`
	`454`	`+`
`451`	`455`	`@_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {`
`452`	`456`	`return GLEW.glGetString(name)`
`453`	`457`	`}`
Original file line number	Diff line number	Diff line change
`@@ -454,6 +454,10 @@ public typealias GLdouble = OpenGL_Linux.GLdouble`
`454`	`454`	`OpenGL_Linux.glViewport(x, y, width, height)`
`455`	`455`	`}`
`456`	`456`
	`457`	`+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {`
	`458`	`+ OpenGL_Linux.glScissor(x, y, width, height)`
	`459`	`+}`
	`460`	`+`
`457`	`461`	`@_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {`
`458`	`462`	`return OpenGL_Linux.glGetString(name)`
`459`	`463`	`}`
Original file line number	Diff line number	Diff line change
`@@ -453,6 +453,10 @@ public typealias GLdouble = OpenGL_Windows.GLdouble`
`453`	`453`	`OpenGL_Windows.glViewport(x, y, width, height)`
`454`	`454`	`}`
`455`	`455`
	`456`	`+@_transparent @usableFromInline internal func _glScissor(_ x: GLint, _ y: GLint, _ width: GLsizei, _ height: GLsizei) {`
	`457`	`+ OpenGL_Windows.glScissor(x, y, width, height)`
	`458`	`+}`
	`459`	`+`
`456`	`460`	`@_transparent @usableFromInline internal func _glGetString(_ name: GLenum) -> UnsafePointer<GLubyte>? {`
`457`	`461`	`return OpenGL_Windows.glGetString(name)`
`458`	`462`	`}`