`glslView-nvim`

When editing GLSL shaders, this plugin provides the command GlslView which will open glslViewer to the file being edited in the current buffer. By default, it is opened with the -l flag so that glslViewer will automatically listen for file changes, updating the preview as you save.

📦 Installation

Install the plugin with your preferred package manager. For example, in packer simply:

  use { 'timtro/glslView-nvim', ft = 'glsl' }

Don't forget to PackerCompile after installation so that the plugin will only be loaded for glsl files. You'll also need a plugin to detect the glsl filetype.

Installing `glslViewer`

See installation in the glslViewer Wiki.

⚙️ Configuration

Configuration is done by passing options to setup(). The defaults are:

require('glslView').setup {
  viewer_path = 'glslViewer',
  args = { '-l' },
}

💪 Usage

Use the command :GlslView to open the current buffer in glslViewer.

Additional arguments will be passed to the executable after any arguments set in configuration.

For example, to start with a 128x256 window:

:GlslView -w 128 -h 256

More primitively, one can call directly through Lua:

:lua require('glslView').glslView({'-w', '128', '-h', '256'})

🧰 Alternatives

vim-GlslViewer - Version drift seems to have rendered it useless (at this time) since it laucnes the process with & to free up the UI, but this causes glslViewer to stop rendering (and then in my case, close).

Path Configuration

I'd like to add configuration for the glslViewer path. My motive was running glslViewer natively under Windows through WSL, without messing with installing a compatible X server.

I wanted your feedback on one of two implementation methods, both of which I've already pushed to my fork. Which would you prefer?

Using a global Vim option (g:glslViewExePath/vim.g.glslViewExePath):

diff --git a/lua/glslView.lua b/lua/glslView.lua
index 12a404c..102efe8 100644
--- a/lua/glslView.lua
+++ b/lua/glslView.lua
@@ -6,7 +6,7 @@ M.glslView = function()
 
   local handle -- pre-declared to avoid diagnostic error.
   handle = vim.loop.spawn(
-    'glslViewer',
+    vim.g.glslViewExePath,
     { args = { full_file_path, '-l' } },
     function()
       handle:close()
diff --git a/plugin/glslView.vim b/plugin/glslView.vim
index 37b9de5..4f5feed 100644
--- a/plugin/glslView.vim
+++ b/plugin/glslView.vim
@@ -1,3 +1,7 @@
 
 command! -nargs=0 -bar GlslView :lua require'glslView'.glslView()
 " autocmd! BufNewFile,BufRead  *.frag GlslView
+
+if !exists('g:glslViewExePath')
+    let g:glslViewExePath = 'glslViewer'
+endif

Using a setup function like I've seen some other neovim plugins use, and would allow future configuration (passing additional options to the executable, for example)

diff --git a/lua/glslView.lua b/lua/glslView.lua
index 12a404c..bdb438e 100644
--- a/lua/glslView.lua
+++ b/lua/glslView.lua
@@ -6,7 +6,7 @@ M.glslView = function()
 
   local handle -- pre-declared to avoid diagnostic error.
   handle = vim.loop.spawn(
-    'glslViewer',
+    M.config.exe_path,
     { args = { full_file_path, '-l' } },
     function()
       handle:close()
@@ -26,4 +26,14 @@ M.glslView = function()
   end
 end
 
+M.setup = function(opts)
+  M.config = {
+    exe_path = 'glslView',
+  }
+
+  if opts ~= nil then
+    M.config = vim.tbl_deep_extend('force', M.config, opts)
+  end
+end
+
 return M

Which would then be used like require('glslView').setup { exe_path = '/path/to/glslViewer' }

Let me know and I'll open the pull request for whichever you prefer.

timtro / glslview-nvim Goto Github PK

glslview-nvim's Introduction

`glslView-nvim`

📦 Installation

Installing `glslViewer`

⚙️ Configuration

💪 Usage

🧰 Alternatives

glslview-nvim's People

Contributors

Stargazers

Watchers

Forkers

glslview-nvim's Issues

Path Configuration

Typo in default exe name

Add features “list” to README.

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

timtro / glslview-nvim Goto Github PK

glslview-nvim's Introduction

glslView-nvim

📦 Installation

Installing glslViewer

⚙️ Configuration

💪 Usage

🧰 Alternatives

glslview-nvim's People

Contributors

Stargazers

Watchers

Forkers

glslview-nvim's Issues

Recommend Projects

Recommend Topics

Recommend Org

`glslView-nvim`

Installing `glslViewer`