hxshader Module¶
Source code: hxshader.py
The hxshader module provides an HxShader class which
derives from ReadWriteFile and is used to read and write
Devil Daggers shader data.
HxShader Class¶
- class vgio.devildaggers.hxshader.HxShader¶
Class for working with HxShaders
- name¶
Shader name.
- vertex_shader¶
Vertex shader code.
- fragment_shader¶
Fragment shader code.
- HxShader.__init__()¶
Constructs an HxShader object.
- classmethod HxShader.open(file, mode='r')¶
Open a ReadWriteFile object where file can be a path to a file (a string), or a file-like object.
The mode parameter should be ‘r’ to read an existing file, ‘w’ to truncate and write a new file, or ‘a’ to append to an existing file.
open() is also a context manager and supports the with statement:
with ReadWriteFile.open('file.ext') as file: file.save('file2.ext')
- Parameters
file – Either the path to the file, a file-like object, or bytes.
mode – An optional string that indicates which mode to open the file
- Returns
An ReadWriteFile object constructed from the information read from the file-like object.
- Raises
ValueError – If an invalid file mode is given.
TypeError – If attempting to write to a bytes object.
OSError – If the file argument is not a file-like object.
- HxShader.close()¶
Closes the file pointer if possible. If mode is ‘w’ or ‘a’, the file will be written to.
- HxShader.save(file)¶
Writes data to file.
- Parameters
file – Either the path to the file, or a file-like object.
- Raises
OSError – If file argument is not a file-like object.