{"id":13661494,"url":"https://github.com/Facepunch/Facepunch.Highlight","last_synced_at":"2025-04-25T02:33:25.530Z","repository":{"id":38427609,"uuid":"145111114","full_name":"Facepunch/Facepunch.Highlight","owner":"Facepunch","description":"Mesh outline effect","archived":false,"fork":false,"pushed_at":"2018-08-20T09:20:50.000Z","size":13,"stargazers_count":317,"open_issues_count":3,"forks_count":21,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-07-13T00:06:40.308Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Facepunch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-17T11:13:54.000Z","updated_at":"2024-06-24T21:49:10.000Z","dependencies_parsed_at":"2022-08-18T08:21:03.634Z","dependency_job_id":null,"html_url":"https://github.com/Facepunch/Facepunch.Highlight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Facepunch%2FFacepunch.Highlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Facepunch%2FFacepunch.Highlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Facepunch%2FFacepunch.Highlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Facepunch%2FFacepunch.Highlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Facepunch","download_url":"https://codeload.github.com/Facepunch/Facepunch.Highlight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213630946,"owners_count":15615381,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T05:01:35.747Z","updated_at":"2024-08-02T05:10:51.935Z","avatar_url":"https://github.com/Facepunch.png","language":"C#","readme":"# Facepunch.Highlight\nMesh outline effect\n\n![](https://files.facepunch.com/garry/a0ad7775-03ac-49e4-83c0-b89301b6f64b.png)\n![](https://files.facepunch.com/garry/b13be668-ba6a-408c-8390-4a016c4d06af.png)\n![](https://files.facepunch.com/garry/6a5153b3-5996-4a31-9005-2b66e811c563.png)\n![](https://files.facepunch.com/garry/745b7309-942e-44ff-a1ca-8dd065c7a943.png)\n# Usage\n\nAdd Highlighter.cs to your camera (or anywhere else and set the camera reference). There's some static functions that will make things easier if you're only using one type of outline.\n\n```\n        Highlight.ClearAll();\n        Highlight.AddRenderer( HoveredRendererer );\n        Highlight.AddRenderer( SomeOtherRendererer );\n        Highlight.Rebuild();\n```\n\nOptimally you should only update the a highlighter when things change, not every frame, but it's not going to kill you if you do.\n\n# Pros And Cons\n\nPros | Cons\n-----|------\nCan add multiple highlighters for different line colours/widths | Only one line colour/width per highlighter\nOnly costs perf when being used | Only works in deferred render mode\nNo need to add components to all your renderers | Needs depth texture generation on camera\nOnly re-renders the target objects | Transparent stuff won't occlude\nDoesn't need to render potentially occluding objects | \nCan draw occluded lines a different colour |\nLines can glow and bloom by providing a HDR color |\nLines can get anti-aliased by post process |\nYou can edit the shader to do whatever you want |\nWorks on skinned meshes |\nMIT license |\n\n","funding_links":[],"categories":["C\\#","Open Source Repositories","Outline","Open Source Packages"],"sub_categories":["Effect-Highlighter","Effect and Shaders"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFacepunch%2FFacepunch.Highlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFacepunch%2FFacepunch.Highlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFacepunch%2FFacepunch.Highlight/lists"}