vrdGLSLShaderParameterList¶
-
class
vrdGLSLShaderParameterList
¶
(Inherits vrdObjectList
)
Summary¶
- Functions:
- append(value)
- append(values)
- at(i) → vrdGLSLShaderParameter
- autoCreate()
- canInsert(value) → bool
- clear()
- contains(value) → bool
- count(value) → integer
- create(name, type) → vrdGLSLShaderParameter
- data() → List[vrdGLSLShaderParameter]
- find(name) → vrdGLSLShaderParameter
- index(value, from, to) → integer
- insert(i, value)
- insert(i, values)
- move(from, to) → bool
- remove(value) → bool
- removeAll(value) → integer
- removeAt(i) → bool
- size() → integer
Functions¶
-
vrdGLSLShaderParameterList.
append
(value)¶ Appends the value to this list.
Parameters: value (vrdGLSLShaderParameter) – The value to append
-
vrdGLSLShaderParameterList.
append
(values)¶ Appends the items of the value list to this list.
Parameters: values (List[vrdGLSLShaderParameter]) – The values to append
-
vrdGLSLShaderParameterList.
at
(i)¶ Get the value at the given index.
Parameters: i (integer) – Returns: i The index of the requested value Return type: vrdGLSLShaderParameter
-
vrdGLSLShaderParameterList.
autoCreate
()¶ Automatically extracts parameter from the used programs, replacing the existing parameter list.
-
vrdGLSLShaderParameterList.
canInsert
(value)¶ Check, if the given entry can be inserted.
Parameters: value (vrdGLSLShaderParameter) – Returns: True, if insert is allowed Return type: bool
-
vrdGLSLShaderParameterList.
clear
()¶ Removes all items from the list.
-
vrdGLSLShaderParameterList.
contains
(value)¶ Check, if an element is already in the list.
Parameters: value (vrdGLSLShaderParameter) – Returns: True, if the given value is in this list Return type: bool
-
vrdGLSLShaderParameterList.
count
(value)¶ Count the occurences of a given vlaue.
Parameters: value (vrdGLSLShaderParameter) – Returns: The number of times, the value has been found in the list Return type: integer
-
vrdGLSLShaderParameterList.
create
(name, type)¶ Create new parameter with given names.
Parameters: - name (string) – Parameter name
- type (vrdGLSLShaderParameterList.ParameterType) – Parameter type
Returns: Return type:
-
vrdGLSLShaderParameterList.
data
()¶ Get all entries of this list.
Returns: List of elements Return type: List[vrdGLSLShaderParameter]
-
vrdGLSLShaderParameterList.
find
(name)¶ Returns first occurrence with given name.
Parameters: name (string) – Name Returns: Return type: vrdGLSLShaderParameter
-
vrdGLSLShaderParameterList.
index
(value, from=0, to=-1)¶ Returns the index of the given value.
Parameters: - value (vrdGLSLShaderParameter) – The value to search
- from (integer) – The index to start the search, default is 0
- to (integer) – The index to end the search, default is -1 to search until the end
Returns: The index or -1, if not found
Return type: integer
-
vrdGLSLShaderParameterList.
insert
(i, value)¶ Insert a value at a given position.
Parameters: - i (integer) – The position, starting from 0
- value (vrdGLSLShaderParameter) – The value to be inserted
-
vrdGLSLShaderParameterList.
insert
(i, values)¶ Insert values at a given position.
Parameters: - i (integer) – The position, starting from 0
- values (List[vrdGLSLShaderParameter]) – The values to be inserted
-
vrdGLSLShaderParameterList.
move
(from, to)¶ Moves a values inside the list.
Parameters: - from (integer) – The index to move
- to (integer) – The destination index
Returns: True on success, False otherwise
Return type: bool
-
vrdGLSLShaderParameterList.
remove
(value)¶ Remove the first occurrence of the given value.
Parameters: value (vrdGLSLShaderParameter) – Returns: True, if the value has been removed Return type: bool
-
vrdGLSLShaderParameterList.
removeAll
(value)¶ Remove all occurences of the given value.
Parameters: value (vrdGLSLShaderParameter) – Returns: The number of value that have been removed Return type: integer
-
vrdGLSLShaderParameterList.
removeAt
(i)¶ Remove a value from the list.
Parameters: i (integer) – Index of the value to be removed Returns: True, if the value has been removed Return type: bool
-
vrdGLSLShaderParameterList.
size
()¶ Returns: Number of elements in this list. Return type: integer