Skip to content

README.md

Latest commit

 

History

History
38 lines (29 loc) · 1.34 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.34 KB

Starlet Graphics

A lightweight graphics loading & management library for Starlet projects with Vulkan and OpenGL engines in mind.

Features

  • Meshes :

    • parsePlyMesh :ASCII PLY loader (triangles only), reads pos and optional norm/col/texcoords
    • MeshLoader : loadMesh, uploadMesh, unloadMesh
    • MeshManager : addMesh, createTriangle, createSquare, createCube, findMesh, getMesh

  • Textures

    • parseBMP : Uncompressed 24-bpp BMP reader
    • TextureLoader : loadTexture2D, loadCubeFaces, uploadTexture2D, uploadTextureCube, unloadTexture
    • TextureManager : addTexture, addCubeTexture, findTexture, getTexture, getTextureID

  • Shaders

    • ShaderLoader : createProgramFromPaths, unloadShader
    • ShaderManager : createProgramFromPaths, useProgram, getProgramID

Folder Conventions (recommended)

  • Meshes : assets/models/*.ply
  • Textures : assets/textures/*.bmp
  • Shaders : assets/shaders/*.glsl Managers support a basePath you can set to your assets folders.

Using as a Dependency

include(FetchContent)

FetchContent_Declare(starlet_graphics
  GIT_REPOSITORY https://github.com/masonlet/starlet-graphics.git 
  GIT_TAG main
)
FetchContent_MakeAvailable(starlet_graphics)

target_link_libraries(app_name PRIVATE starlet_graphics)