oshi.hardware.GraphicsCard Maven / Gradle / Ivy
/**
* MIT License
*
* Copyright (c) 2010 - 2020 The OSHI Project Contributors: https://github.com/oshi/oshi/graphs/contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package oshi.hardware;
import oshi.annotation.concurrent.Immutable;
/**
*
* GraphicsCard interface.
*
*/
@Immutable
public interface GraphicsCard {
/**
* Retrieves the full name of the card.
*
* @return The name of the card.
*/
String getName();
/**
* Retrieves the card's Device ID
*
* @return The Device ID of the card
*/
String getDeviceId();
/**
* Retrieves the card's manufacturer/vendor
*
* @return The vendor of the card as human-readable text if possible, or the
* Vendor ID (VID) otherwise
*/
String getVendor();
/**
* Retrieves a list of version/revision data from the card. Users may need to
* further parse this list to identify specific GPU capabilities.
*
* @return A comma-delimited list of version/revision data
*/
String getVersionInfo();
/**
* Retrieves the Video RAM (VRAM) available on the GPU
*
* @return Total number of bytes.
*/
long getVRam();
}