basilisk-engine 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

basilisk/render/framebuffer.py

@@ -1,106 +1,131 @@
-import moderngl as mgl
-from PIL import Image
-
-
-
-class Framebuffer:
-    engine: ...
-    """Reference to the parent engine"""
-    fbo: mgl.Framebuffer = None
-    """The core framebuffer the object provides abstraction for."""
-    texture: mgl.Texture = None
-    """The color texture of the framebuffer"""
-    depth: mgl.Texture = None
-    """The depth texture of the framebuffer"""
-    size: tuple[int]
-    """The dimensions of the framebuffer (x, y)"""
-
-    def __init__(self, engine, size: tuple[int]=None, components: int=4, filter=(mgl.LINEAR, mgl.LINEAR)) -> None:
-        """
-        Abstraction to the mgl framebuffer
-        Args:
-            engine: mgl.Engine: 
-                The parent engine
-            size: tuple[int]: 
-                The dimensions of the framebuffer (x, y)
-        """
-        
-        # Set attributes
-        self.engine = engine
-        self.ctx = engine.ctx
-        self.size = size if size else engine.win_size
-        self.components = components
-
-        # Create the fbo
-        self.texture = self.ctx.texture(self.size, components=self.components)
-        self.depth = self.ctx.depth_texture(self.size)
-        self.fbo   = self.ctx.framebuffer([self.texture], self.depth)
-
-        print()
-
-        self.filter = filter
-
-    def use(self) -> None:
-        """
-        Select this framebuffer for use
-        """
-
-        self.fbo.use()
-
-    def clear(self) -> None:
-        """
-        Clear all data currently in the textures (set to black)        
-        """
-
-        self.fbo.clear()
-
-    def save(self, destination: str=None) -> None:
-        """
-        Saves the frame as an image to the given file destination
-        """
-
-        path = destination if destination else 'screenshot'
-
-        data = self.fbo.read(components=3, alignment=1)
-        img = Image.frombytes('RGB', self.size, data).transpose(Image.FLIP_TOP_BOTTOM)
-        img.save(f'{path}.png')
-
-    def resize(self, size: tuple[int]=None) -> None:
-        """
-        Resize the buffer to the given size. None for window size
-        """
-
-        # Release old memory
-        self.__del__()
-
-        # Set/get size attribute
-        self.size = size if size else self.engine.win_size
-
-        # Create the fbo
-        self.texture = self.ctx.texture(self.size, components=self.components)
-        self.depth = self.ctx.depth_texture(self.size)
-        self.fbo   = self.ctx.framebuffer([self.texture], self.depth)
-
-        self.filter = self._filter
-
-    @property
-    def data(self):
-        return self.fbo.read(components=3, alignment=1)
-
-    @property
-    def filter(self):
-        return self.texture.filter
-    
-    @filter.setter
-    def filter(self, value):
-        self._filter = value
-        self.texture.filter = value
-
-    def __repr__(self) -> str:
-        return f'<bsk.Framebuffer | size: {self.size}>' 
-
-    def __del__(self) -> None:
-        # Release any existing memory in case of a resize
-        if self.texture: self.texture.release()
-        if self.depth: self.depth.release()
+import numpy as np
+import moderngl as mgl
+from PIL import Image
+from ..render.shader import Shader
+
+
+class Framebuffer:
+    engine: ...
+    """Reference to the parent engine"""
+    fbo: mgl.Framebuffer = None
+    """The core framebuffer the object provides abstraction for."""
+    texture: mgl.Texture = None
+    """The color texture of the framebuffer"""
+    depth: mgl.Texture = None
+    """The depth texture of the framebuffer"""
+    size: tuple[int]
+    """The dimensions of the framebuffer (x, y)"""
+
+    def __init__(self, engine, size: tuple[int]=None, resolution_scale: float=1.0, components: int=4, filter=(mgl.LINEAR, mgl.LINEAR)) -> None:
+        """
+        Abstraction to the mgl framebuffer
+        Args:
+            engine: mgl.Engine: 
+                The parent engine
+            size: tuple[int]: 
+                The dimensions of the framebuffer (x, y)
+        """
+        
+        # Set attributes
+        self.engine = engine
+        self.ctx = engine.ctx
+        self.components = components
+
+        # Set the size
+        self.resolution_scale = resolution_scale
+        self._size = size
+        self.size = self._size if self._size else self.engine.win_size
+        self.size = (int(self.size[0] * resolution_scale), int(self.size[1] * resolution_scale))
+        
+        # Create the fbo
+        self.texture = self.ctx.texture(self.size, components=self.components)
+        self.depth = self.ctx.depth_texture(self.size)
+        self.fbo   = self.ctx.framebuffer([self.texture], self.depth)
+
+        # Load Shaders
+        self.shader = Shader(self.engine, self.engine.root + '/shaders/frame.vert', self.engine.root + '/shaders/frame.frag')
+        self.engine.scene.shader_handler.add(self.shader)
+
+        # Load VAO
+        self.vbo = self.ctx.buffer(np.array([[-1, -1, 0, 0, 0], [1, -1, 0, 1, 0], [1, 1, 0, 1, 1], [-1, 1, 0, 0, 1], [-1, -1, 0, 0, 0], [1, 1, 0, 1, 1]], dtype='f4'))
+        self.vao = self.ctx.vertex_array(self.shader.program, [(self.vbo, '3f 2f', 'in_position', 'in_uv')], skip_errors=True)
+
+        # Save the filter
+        self.filter = filter
+
+        # Add to the engine for updates
+        self.engine.fbos.append(self)
+
+    def render(self) -> None:
+        self.shader.program['screenTexture'] = 0
+        self.texture.use(location=0)
+        self.vao.render()
+
+    def use(self) -> None:
+        """
+        Select this framebuffer for use
+        """
+
+        self.fbo.use()
+
+    def clear(self) -> None:
+        """
+        Clear all data currently in the textures (set to black)        
+        """
+
+        self.fbo.clear()
+
+    def save(self, destination: str=None) -> None:
+        """
+        Saves the frame as an image to the given file destination
+        """
+
+        path = destination if destination else 'screenshot'
+
+        data = self.fbo.read(components=3, alignment=1)
+        img = Image.frombytes('RGB', self.size, data).transpose(Image.FLIP_TOP_BOTTOM)
+        img.save(f'{path}.png')
+
+    def resize(self, size: tuple[int]=None) -> None:
+        """
+        Resize the buffer to the given size. None for window size
+        """
+
+        # Release old memory
+        self.__del__()
+
+        # Set/get size attribute
+        if size:
+            self.size = size
+        else:
+            self.size = self._size if self._size else self.engine.win_size
+        self.size = (int(self.size[0] * self.resolution_scale), int(self.size[1] * self.resolution_scale))
+
+        # Create the fbo
+        self.texture = self.ctx.texture(self.size, components=self.components)
+        self.depth = self.ctx.depth_texture(self.size)
+        self.fbo   = self.ctx.framebuffer([self.texture], self.depth)
+
+        self.filter = self._filter
+
+    @property
+    def data(self):
+        return self.fbo.read(components=3, alignment=1)
+
+    @property
+    def filter(self):
+        return self.texture.filter
+    
+    @filter.setter
+    def filter(self, value):
+        self._filter = value
+        self.texture.filter = value
+
+    def __repr__(self) -> str:
+        return f'<bsk.Framebuffer | size: {self.size}>' 
+
+    def __del__(self) -> None:
+        # Release any existing memory in case of a resize
+        if self.texture: self.texture.release()
+        if self.depth: self.depth.release()
         if self.fbo:   self.fbo.release()

basilisk/render/image.py

@@ -1,88 +1,88 @@
-import os
-import sys
-import numpy as np
-import moderngl as mgl
-import glm
-import pygame as pg
-from PIL import Image as PIL_Image
-
-
-texture_sizes = (8, 64, 512, 1024, 2048)
-
-
-class Image():
-    name: str
-    """Name of the image"""   
-    index: glm.ivec2
-    """Location of the image in the texture arrays"""
-    data: np.ndarray
-    """Array of the texture data"""
-    size: int
-    """The width and height in pixels of the image"""
-
-    def __init__(self, path: str | os.PathLike | pg.Surface | mgl.Texture) -> None:
-        """
-        A basilisk image object that contains a moderngl texture
-        Args:
-            path: str | os.PathLike | pg.Surface
-                The string path to the image. Can also read a pygame surface
-        """
-        
-        # Check if the user is loading a pygame surface
-        if isinstance(path, str) or isinstance(path, os.PathLike):
-            return self._from_path(path)
-        elif isinstance(path, pg.Surface):
-            return self._from_surfaces(path)
-        elif isinstance(path, mgl.Texture):
-            return self._from_texture(path)
-        
-        raise TypeError(f'Invalid path type: {type(path)}. Expected a string or os.PathLike')
-
-    def _from_path(self, path: str | os.PathLike) -> None:
-        """
-        Loads a basilisk image from a pygame surface
-        Args:
-        """
-        
-        # Get name from path
-        self.name = path.split('/')[-1].split('\\')[-1].split('.')[0]
-
-        # Load image
-        img = PIL_Image.open(path).convert('RGBA')
-        # Set the size in one of the size buckets
-        size_buckets = texture_sizes
-        self.size = size_buckets[np.argmin(np.array([abs(size - img.size[0]) for size in size_buckets]))]
-        img = img.resize((self.size, self.size)) 
-        # Get the image data
-        self.data = img.tobytes()
-
-        # Default index value (to be set by image handler)
-        self.index = glm.ivec2(1, 1)
-
-    def _from_surface(self, surf: pg.Surface) -> None:
-        """
-        Loads a basilisk image from a pygame surface
-        Args:
-        """
-        
-        # Set the size in one of the size buckets
-        size_buckets = texture_sizes
-        self.size = size_buckets[np.argmin(np.array([abs(size - surf.get_size()[0]) for size in size_buckets]))]
-        surf = pg.transform.scale(surf, (self.size, self.size)).convert_alpha()
-        # Get image data
-        self.data = pg.image.tobytes(surf, 'RGBA')
-
-        # Default index value (to be set by image handler)
-        self.index = glm.ivec2(1, 1)
-
-    def _from_texture(self, texture: mgl.Texture):
-        """
-        
-        """
-        ...
-
-    def __repr__(self) -> str:
-        """
-        Returns a string representation of the object
-        """
+import os
+import sys
+import numpy as np
+import moderngl as mgl
+import glm
+import pygame as pg
+from PIL import Image as PIL_Image
+
+
+texture_sizes = (8, 64, 512, 1024, 2048)
+
+
+class Image():
+    name: str
+    """Name of the image"""   
+    index: glm.ivec2
+    """Location of the image in the texture arrays"""
+    data: np.ndarray
+    """Array of the texture data"""
+    size: int
+    """The width and height in pixels of the image"""
+
+    def __init__(self, path: str | os.PathLike | pg.Surface | mgl.Texture) -> None:
+        """
+        A basilisk image object that contains a moderngl texture
+        Args:
+            path: str | os.PathLike | pg.Surface
+                The string path to the image. Can also read a pygame surface
+        """
+        
+        # Check if the user is loading a pygame surface
+        if isinstance(path, str) or isinstance(path, os.PathLike):
+            return self._from_path(path)
+        elif isinstance(path, pg.Surface):
+            return self._from_surfaces(path)
+        elif isinstance(path, mgl.Texture):
+            return self._from_texture(path)
+        
+        raise TypeError(f'Invalid path type: {type(path)}. Expected a string or os.PathLike')
+
+    def _from_path(self, path: str | os.PathLike) -> None:
+        """
+        Loads a basilisk image from a pygame surface
+        Args:
+        """
+        
+        # Get name from path
+        self.name = path.split('/')[-1].split('\\')[-1].split('.')[0]
+
+        # Load image
+        img = PIL_Image.open(path).convert('RGBA')
+        # Set the size in one of the size buckets
+        size_buckets = texture_sizes
+        self.size = size_buckets[np.argmin(np.array([abs(size - img.size[0]) for size in size_buckets]))]
+        img = img.resize((self.size, self.size)) 
+        # Get the image data
+        self.data = img.tobytes()
+
+        # Default index value (to be set by image handler)
+        self.index = glm.ivec2(1, 1)
+
+    def _from_surface(self, surf: pg.Surface) -> None:
+        """
+        Loads a basilisk image from a pygame surface
+        Args:
+        """
+        
+        # Set the size in one of the size buckets
+        size_buckets = texture_sizes
+        self.size = size_buckets[np.argmin(np.array([abs(size - surf.get_size()[0]) for size in size_buckets]))]
+        surf = pg.transform.scale(surf, (self.size, self.size)).convert_alpha()
+        # Get image data
+        self.data = pg.image.tobytes(surf, 'RGBA')
+
+        # Default index value (to be set by image handler)
+        self.index = glm.ivec2(1, 1)
+
+    def _from_texture(self, texture: mgl.Texture):
+        """
+        
+        """
+        ...
+
+    def __repr__(self) -> str:
+        """
+        Returns a string representation of the object
+        """
         return f'<Basilisk Image | {self.name}, ({self.size}x{self.size}), {sys.getsizeof(self.data) / 1024 / 1024:.2} mb>'

basilisk/render/image_handler.py

@@ -1,123 +1,123 @@
-import moderngl as mgl
-import glm
-import numpy as np
-
-
-texture_sizes = (8, 64, 512, 1024, 2048)
-
-
-class ImageHandler():
-    engine: any
-    """Back refernce to the parent engine"""
-    scene: any
-    """Back refernce to the parent scene"""
-    ctx: mgl.Context
-    """Back reference to the Context used by the scene/engine"""
-    images: list
-    """List of basilisk Images containing all the loaded images given to the scene"""
-    texture_arrays: dict
-    """Dictionary of textures arrays for writting textures to GPU"""
-
-    def __init__(self, scene) -> None:
-        """
-        Container for all the basilisk image objects in the scene.
-        Handles the managment and writting of all image textures.
-        """
-        
-        # Set back references
-        self.scene  = scene
-        self.engine = scene.engine
-        self.ctx    = scene.engine.ctx
-
-        self.images = []
-        self.texture_arrays = {size : [] for size in texture_sizes}
-
-    def add(self, image: any) -> None:
-        """
-        Adds an existing basilisk image object to the handler for writting
-        Args:
-            image: bsk.Image
-                The existing image that is to be added to the scene.
-        """
-        
-        if image in self.images: return
-
-        self.images.append(image)
-        self.write(regenerate=True)
-
-    def generate_texture_array(self) -> None:
-        """
-        Generates texutre arrays for all the images. Updates the index of the image instance
-        """
-
-        # Release any existsing texture arrays
-        for texture_array in self.texture_arrays.values():
-            if not texture_array: continue
-            texture_array.release()
-
-        self.texture_arrays = {size : [] for size in texture_sizes}
-
-        for image in self.images:
-            # Add the image data to the array
-            self.texture_arrays[image.size].append(image.data)
-            # Update the image index
-            image.index = glm.ivec2(texture_sizes.index(image.size), len(self.texture_arrays[image.size]) - 1)
-
-
-        for size in self.texture_arrays:
-            # Check that there are textures in the bucket
-            if not len(self.texture_arrays[size]): continue
-            array_data = np.array(self.texture_arrays[size])
-            dim = (size, size, len(self.texture_arrays[size]))
-            
-            # Make the array
-            self.texture_arrays[size] = self.ctx.texture_array(size=dim, components=4, data=array_data)
-            # Texture OpenGl settings
-            self.texture_arrays[size].build_mipmaps()
-            if size > 32: self.texture_arrays[size].filter = (mgl.LINEAR_MIPMAP_LINEAR, mgl.LINEAR)
-            else: self.texture_arrays[size].filter = (mgl.NEAREST, mgl.NEAREST)
-            self.texture_arrays[size].anisotropy = 32.0
-
-    def write(self, regenerate=False) -> None:
-        """
-        Writes all texture arrays to shaders that use images 
-        """
-
-        if regenerate: self.generate_texture_array()
-
-        if not self.texture_arrays: return
-
-        for shader in self.engine.scene.shader_handler.shaders:
-            if 'textureArrays[5]' not in shader.uniforms: continue
-
-            for i, size in enumerate(texture_sizes):
-                if not size in self.texture_arrays: continue
-                if not self.texture_arrays[size]: continue
-                shader.program[f'textureArrays[{i}].array'] = i + 3
-                self.texture_arrays[size].use(location=i+3)
-
-    def get(self, identifier: str | int) -> any:
-        """
-        Gets the basilisk image with the given name or index
-        Args:
-            identifier: str | int
-                The name string or index of the desired image
-        """
-
-        # Simply use index if given
-        if isinstance(identifier, int): return self.images[identifier]
-
-        # Else, search the list for an image with the given name
-        for image in self.images:
-            if image.name != identifier: continue
-            return image
-        
-        # No matching image found
-        return None
-    
-    def __del__(self):
-        """
-        Deallocates all texture arrays
-        """
-        
+import moderngl as mgl
+import glm
+import numpy as np
+
+
+texture_sizes = (8, 64, 512, 1024, 2048)
+
+
+class ImageHandler():
+    engine: any
+    """Back refernce to the parent engine"""
+    scene: any
+    """Back refernce to the parent scene"""
+    ctx: mgl.Context
+    """Back reference to the Context used by the scene/engine"""
+    images: list
+    """List of basilisk Images containing all the loaded images given to the scene"""
+    texture_arrays: dict
+    """Dictionary of textures arrays for writting textures to GPU"""
+
+    def __init__(self, scene) -> None:
+        """
+        Container for all the basilisk image objects in the scene.
+        Handles the managment and writting of all image textures.
+        """
+        
+        # Set back references
+        self.scene  = scene
+        self.engine = scene.engine
+        self.ctx    = scene.engine.ctx
+
+        self.images = []
+        self.texture_arrays = {size : [] for size in texture_sizes}
+
+    def add(self, image: any) -> None:
+        """
+        Adds an existing basilisk image object to the handler for writting
+        Args:
+            image: bsk.Image
+                The existing image that is to be added to the scene.
+        """
+        
+        if image in self.images: return
+
+        self.images.append(image)
+        self.write(regenerate=True)
+
+    def generate_texture_array(self) -> None:
+        """
+        Generates texutre arrays for all the images. Updates the index of the image instance
+        """
+
+        # Release any existsing texture arrays
+        for texture_array in self.texture_arrays.values():
+            if not texture_array: continue
+            texture_array.release()
+
+        self.texture_arrays = {size : [] for size in texture_sizes}
+
+        for image in self.images:
+            # Add the image data to the array
+            self.texture_arrays[image.size].append(image.data)
+            # Update the image index
+            image.index = glm.ivec2(texture_sizes.index(image.size), len(self.texture_arrays[image.size]) - 1)
+
+
+        for size in self.texture_arrays:
+            # Check that there are textures in the bucket
+            if not len(self.texture_arrays[size]): continue
+            array_data = np.array(self.texture_arrays[size])
+            dim = (size, size, len(self.texture_arrays[size]))
+            
+            # Make the array
+            self.texture_arrays[size] = self.ctx.texture_array(size=dim, components=4, data=array_data)
+            # Texture OpenGl settings
+            self.texture_arrays[size].build_mipmaps()
+            if size > 32: self.texture_arrays[size].filter = (mgl.LINEAR_MIPMAP_LINEAR, mgl.LINEAR)
+            else: self.texture_arrays[size].filter = (mgl.NEAREST, mgl.NEAREST)
+            self.texture_arrays[size].anisotropy = 32.0
+
+    def write(self, regenerate=False) -> None:
+        """
+        Writes all texture arrays to shaders that use images 
+        """
+
+        if regenerate: self.generate_texture_array()
+
+        if not self.texture_arrays: return
+
+        for shader in self.engine.scene.shader_handler.shaders:
+            if 'textureArrays[5]' not in shader.uniforms: continue
+
+            for i, size in enumerate(texture_sizes):
+                if not size in self.texture_arrays: continue
+                if not self.texture_arrays[size]: continue
+                shader.program[f'textureArrays[{i}].array'] = i + 3
+                self.texture_arrays[size].use(location=i+3)
+
+    def get(self, identifier: str | int) -> any:
+        """
+        Gets the basilisk image with the given name or index
+        Args:
+            identifier: str | int
+                The name string or index of the desired image
+        """
+
+        # Simply use index if given
+        if isinstance(identifier, int): return self.images[identifier]
+
+        # Else, search the list for an image with the given name
+        for image in self.images:
+            if image.name != identifier: continue
+            return image
+        
+        # No matching image found
+        return None
+    
+    def __del__(self):
+        """
+        Deallocates all texture arrays
+        """
+        
         # [texture_array.release() for texture_array in self.texture_arrays]